@ndustrial/contxt-sdk 4.3.4 → 5.1.0

package/esm/facilities/groupings.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["facilities/groupings.js"],"names":["isPlainObject","toCamelCase","toSnakeCase","FacilityGroupings","sdk","request","baseUrl","_baseUrl","_request","_sdk","facilityGroupingId","facilityId","errorMsg","Promise","reject","Error","post","then","groupingFacility","grouping","requiredFields","i","length","field","delete","get","groupings","organizationId","update","formattedUpdate","excludeKeys","put"],"mappings":";;;;AAAA,OAAOA,aAAP,MAA0B,sBAA1B;AACA,SAASC,WAAT,EAAsBC,WAAtB,QAAyC,kBAAzC;;AAEA;;;;;;;;;;;;;;AAcA;;;;;;;;;AASA;;;;;;;IAMMC,iB;AACJ;;;;;AAKA,6BAAYC,GAAZ,EAAiBC,OAAjB,EAA0BC,OAA1B,EAAmC;AAAA;;AACjC,SAAKC,QAAL,GAAgBD,OAAhB;AACA,SAAKE,QAAL,GAAgBH,OAAhB;AACA,SAAKI,IAAL,GAAYL,GAAZ;AACD;;AAED;;;;;;;;;;;;;;;;;;;;;;;gCAmBYM,kB,EAAoBC,U,EAAY;AAC1C,UAAIC,iBAAJ;;AAEA,UAAI,CAACF,kBAAL,EAAyB;AACvBE,mBACE,uGADF;AAED,OAHD,MAGO,IAAI,CAACD,UAAL,EAAiB;AACtBC,mBACE,+FADF;AAED;;AAED,UAAIA,QAAJ,EAAc;AACZ,eAAOC,QAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAUH,QAAV,CAAf,CAAP;AACD;;AAED,aAAO,KAAKJ,QAAL,CACJQ,IADI,CAGD,KAAKT,QAHJ,mBAIWG,kBAJX,kBAI0CC,UAJ1C,EAMJM,IANI,CAMC,UAACC,gBAAD;AAAA,eAAsBjB,YAAYiB,gBAAZ,CAAtB;AAAA,OAND,CAAP;AAOD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6BA6BsB;AAAA,UAAfC,QAAe,uEAAJ,EAAI;;AACpB,UAAMC,iBAAiB,CAAC,MAAD,EAAS,gBAAT,CAAvB;;AAEA,WAAK,IAAIC,IAAI,CAAb,EAAgBD,eAAeE,MAAf,GAAwBD,CAAxC,EAA2CA,GAA3C,EAAgD;AAC9C,YAAME,QAAQH,eAAeC,CAAf,CAAd;;AAEA,YAAI,CAACF,SAASI,KAAT,CAAL,EAAsB;AACpB,iBAAOV,QAAQC,MAAR,CACL,IAAIC,KAAJ,QAAeQ,KAAf,qDADK,CAAP;AAGD;AACF;;AAED,aAAO,KAAKf,QAAL,CACJQ,IADI,CACI,KAAKT,QADT,iBAC+BL,YAAYiB,QAAZ,CAD/B,EAEJF,IAFI,CAEC,UAACE,QAAD;AAAA,eAAclB,YAAYkB,QAAZ,CAAd;AAAA,OAFD,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;;;4BAiBOT,kB,EAAoB;AACzB,UAAI,CAACA,kBAAL,EAAyB;AACvB,eAAOG,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,sEADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKP,QAAL,CAAcgB,MAAd,CACF,KAAKjB,QADH,mBACyBG,kBADzB,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;;;6BAiBS;AACP,aAAO,KAAKF,QAAL,CACJiB,GADI,CACG,KAAKlB,QADR,iBAEJU,IAFI,CAEC,UAACS,SAAD;AAAA,eAAezB,YAAYyB,SAAZ,CAAf;AAAA,OAFD,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;;;;;2CAmBuBC,c,EAAgB;AACrC,UAAI,CAACA,cAAL,EAAqB;AACnB,eAAOd,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,2FADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKP,QAAL,CACJiB,GADI,CACG,KAAKlB,QADR,uBACkCoB,cADlC,iBAEJV,IAFI,CAEC,UAACS,SAAD;AAAA,eAAezB,YAAYyB,SAAZ,CAAf;AAAA,OAFD,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;;;mCAiBehB,kB,EAAoBC,U,EAAY;AAC7C,UAAIC,iBAAJ;;AAEA,UAAI,CAACF,kBAAL,EAAyB;AACvBE,mBACE,uGADF;AAED,OAHD,MAGO,IAAI,CAACD,UAAL,EAAiB;AACtBC,mBACE,+FADF;AAED;;AAED,UAAIA,QAAJ,EAAc;AACZ,eAAOC,QAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAUH,QAAV,CAAf,CAAP;AACD;;AAED,aAAO,KAAKJ,QAAL,CAAcgB,MAAd,CACF,KAAKjB,QADH,mBACyBG,kBADzB,kBACwDC,UADxD,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BA4BOD,kB,EAAoBkB,O,EAAQ;AACjC,UAAI,CAAClB,kBAAL,EAAyB;AACvB,eAAOG,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,mEADF,CADK,CAAP;AAKD;;AAED,UAAI,CAACa,OAAL,EAAa;AACX,eAAOf,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,qDAAV,CADK,CAAP;AAGD;;AAED,UAAI,CAACf,cAAc4B,OAAd,CAAL,EAA4B;AAC1B,eAAOf,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,6FADF,CADK,CAAP;AAKD;;AAED,UAAMc,kBAAkB3B,YAAY0B,OAAZ,EAAoB;AAC1CE,qBAAa,CAAC,IAAD,EAAO,gBAAP,EAAyB,SAAzB;AAD6B,OAApB,CAAxB;;AAIA,aAAO,KAAKtB,QAAL,CACJuB,GADI,CACG,KAAKxB,QADR,mBAC8BG,kBAD9B,EACoDmB,eADpD,EAEJZ,IAFI,CAEC,UAACE,QAAD;AAAA,eAAclB,YAAYkB,QAAZ,CAAd;AAAA,OAFD,CAAP;AAGD;;;;;;AAGH,eAAehB,iBAAf","file":"groupings.js","sourcesContent":["import isPlainObject from 'lodash.isplainobject';\nimport { toCamelCase, toSnakeCase } from '../utils/objects';\n\n/**\n * @typedef {Object} FacilityGrouping\n * @param {string} createdAt ISO 8601 Extended Format date/time string\n * @param {string} [description]\n * @param {Facility[]} [facilities]\n * @param {string} id UUID\n * @param {boolean} isPrivate\n * @param {string} name\n * @param {string} organizationId UUID\n * @param {string} ownerId Auth0 identifer of the user\n * @param {string} [parentGroupingId] UUID\n * @param {string} updatedAt ISO 8601 Extended Format date/time string\n */\n\n/**\n * @typedef {Object} FacilityGroupingFacility\n * @param {string} createdAt ISO 8601 Extended Format date/time string\n * @param {string} facilityGroupingId UUID\n * @param {number} facilityId\n * @param {string} id UUID\n * @param {string} updatedAt ISO 8601 Extended Format date/time string\n */\n\n/**\n * Module that provides access to facility groupings, and helps manage\n * the relationship between those groupings and facilities\n *\n * @typicalname contxtSdk.facilities.groupings\n */\nclass FacilityGroupings {\n  /**\n   * @param {Object} sdk An instance of the SDK so the module can communicate with other modules\n   * @param {Object} request An instance of the request module tied to this module's audience.\n   * @param {string} baseUrl The base URL provided by the parent module\n   */\n  constructor(sdk, request, baseUrl) {\n    this._baseUrl = baseUrl;\n    this._request = request;\n    this._sdk = sdk;\n  }\n\n  /**\n   * Adds a facility to a facility grouping\n   *\n   * API Endpoint: '/groupings/:facilityGroupingId/facilities/:facilityId'\n   * Method: POST\n   *\n   * @param {string} facilityGroupingId UUID corresponding with a facility grouping\n   * @param {number} facilityId\n   *\n   * @returns {Promise}\n   * @fulfill {FacilityGroupingFacility} Information about the new facility/grouping relationship\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities.groupings\n   *   .addFacility('b3dbaae3-25dd-475b-80dc-66296630a8d0', 4)\n   *   .then((grouping) => console.log(grouping))\n   *   .catch((err) => console.log(err));\n   */\n  addFacility(facilityGroupingId, facilityId) {\n    let errorMsg;\n\n    if (!facilityGroupingId) {\n      errorMsg =\n        'A facilityGroupingId is required to create a relationship between a facility grouping and a facility.';\n    } else if (!facilityId) {\n      errorMsg =\n        'A facilityId is required to create a relationship between a facility grouping and a facility.';\n    }\n\n    if (errorMsg) {\n      return Promise.reject(new Error(errorMsg));\n    }\n\n    return this._request\n      .post(\n        `${\n          this._baseUrl\n        }/groupings/${facilityGroupingId}/facility/${facilityId}`\n      )\n      .then((groupingFacility) => toCamelCase(groupingFacility));\n  }\n\n  /**\n   * Creates a new facility grouping\n   *\n   * API Endpoint: '/groupings'\n   * Method: POST\n   *\n   * @param {Object} facilityGrouping\n   * @param {string} [facilityGrouping.description]\n   * @param {boolean} [facilityGrouping.isPrivate = false]\n   * @param {string} facilityGrouping.name\n   * @param {string} facilityGrouping.organizationId UUID\n   * @param {string} [facilityGrouping.parentGroupingId] UUID\n   *\n   * @returns {Promise}\n   * @fulfill {FacilityGrouping} Information about the new facility grouping\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities.groupings\n   *   .create({\n   *     description: 'US States of CT, MA, ME, NH, RI, VT',\n   *     isPrivate: false,\n   *     name: 'New England, USA',\n   *     organizationId: '61f5fe1d-d202-4ae7-af76-8f37f5bbeec5',\n   *     parentGroupingId: 'e9f8f89c-609c-4c83-8ebc-cea928af661e'\n   *   })\n   *   .then((grouping) => console.log(grouping))\n   *   .catch((err) => console.log(err));\n   */\n  create(grouping = {}) {\n    const requiredFields = ['name', 'organizationId'];\n\n    for (let i = 0; requiredFields.length > i; i++) {\n      const field = requiredFields[i];\n\n      if (!grouping[field]) {\n        return Promise.reject(\n          new Error(`A ${field} is required to create a new facility grouping.`)\n        );\n      }\n    }\n\n    return this._request\n      .post(`${this._baseUrl}/groupings`, toSnakeCase(grouping))\n      .then((grouping) => toCamelCase(grouping));\n  }\n\n  /**\n   * Delete a facility groupings\n   *\n   * API Endpoint: '/groupings/:facilityGroupingId'\n   * Method: DELETE\n   *\n   * @param {string} facilityGroupingId The id of the facility grouping (formatted as a UUID)\n   *\n   * @returns {Promise}\n   * @fulfill {undefined}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities.groupings.delete(\n   *   'e4fec739-56aa-4b50-8dab-e9d6b9c91a5d'\n   * );\n   */\n  delete(facilityGroupingId) {\n    if (!facilityGroupingId) {\n      return Promise.reject(\n        new Error(\n          'A facility grouping id is required for deleting a facility grouping.'\n        )\n      );\n    }\n\n    return this._request.delete(\n      `${this._baseUrl}/groupings/${facilityGroupingId}`\n    );\n  }\n\n  /**\n   * Get a listing of all facility groupings available to a user. Includes public groupings across\n   * any organization the user has access to and the user's private groupings.\n   *\n   * API Endpoint: '/groupings'\n   * Method: GET\n   *\n   * @returns {Promise}\n   * @fulfill {FacilityGrouping[]}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilites.groupings\n   *   .getAll()\n   *   .then((groupings) => console.log(groupings))\n   *   .catch((err) => console.log(err));\n   */\n  getAll() {\n    return this._request\n      .get(`${this._baseUrl}/groupings`)\n      .then((groupings) => toCamelCase(groupings));\n  }\n\n  /**\n   * Get a listing of all facility groupings for an organization. Includes public groupings\n   * across that specific organization and the user's private groupings for that organization.\n   *\n   * API Endpoint: '/organizations/:organizationId/groupings'\n   * Method: GET\n   *\n   * @param {string} organizationId UUID corresponding with an organization\n   *\n   * @returns {Promise}\n   * @fulfill {FacilityGrouping[]}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilites.groupings\n   *   .getAllByOrganizationId('349dbd36-5dca-4a10-b54d-d0f71c3c8709')\n   *   .then((groupings) => console.log(groupings))\n   *   .catch((err) => console.log(err));\n   */\n  getAllByOrganizationId(organizationId) {\n    if (!organizationId) {\n      return Promise.reject(\n        new Error(\n          \"An organization id is required for getting a list of an organization's facility groupings\"\n        )\n      );\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/organizations/${organizationId}/groupings`)\n      .then((groupings) => toCamelCase(groupings));\n  }\n\n  /**\n   * Removes a facility from a facility grouping\n   *\n   * API Endpoint: '/groupings/:facilityGroupingId/facilities/:facilityId'\n   * Method: DELETE\n   *\n   * @param {string} facilityGroupingId UUID corresponding with a facility grouping\n   * @param {number} facilityId\n   *\n   * @returns {Promise}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities.groupings\n   *   .removeFacility('b3dbaae3-25dd-475b-80dc-66296630a8d0', 4)\n   *   .catch((err) => console.log(err));\n   */\n  removeFacility(facilityGroupingId, facilityId) {\n    let errorMsg;\n\n    if (!facilityGroupingId) {\n      errorMsg =\n        'A facilityGroupingId is required to remove a relationship between a facility grouping and a facility.';\n    } else if (!facilityId) {\n      errorMsg =\n        'A facilityId is required to remove a relationship between a facility grouping and a facility.';\n    }\n\n    if (errorMsg) {\n      return Promise.reject(new Error(errorMsg));\n    }\n\n    return this._request.delete(\n      `${this._baseUrl}/groupings/${facilityGroupingId}/facility/${facilityId}`\n    );\n  }\n\n  /**\n   * Updates an existing facility grouping\n   *\n   * API Endpoint: '/groupings/:facilityGroupingId'\n   * Method: PUT\n   *\n   * @param {String} facilityGroupingId\n   * @param {Object} update\n   * @param {string} [update.description]\n   * @param {boolean} [update.isPrivate]\n   * @param {string} [update.name]\n   * @param {string} [update.parentGroupingId] UUID corresponding with another facility grouping\n   *\n   * @returns {Promise}\n   * @fulfill {FacilityGrouping} Information about the updated facility grouping\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities.groupings\n   *   .update('b3dbaae3-25dd-475b-80dc-66296630a8d0', {\n   *     description: 'US States of CT, MA, ME, NH, RI, VT',\n   *     isPrivate: false,\n   *     name: 'New England, USA',\n   *     parentGroupingId: 'e9f8f89c-609c-4c83-8ebc-cea928af661e'\n   *   })\n   *   .then((grouping) => console.log(grouping))\n   *   .catch((err) => console.log(err));\n   */\n  update(facilityGroupingId, update) {\n    if (!facilityGroupingId) {\n      return Promise.reject(\n        new Error(\n          'A facility grouping id is required to update a facility grouping.'\n        )\n      );\n    }\n\n    if (!update) {\n      return Promise.reject(\n        new Error('An update is required to update a facility grouping')\n      );\n    }\n\n    if (!isPlainObject(update)) {\n      return Promise.reject(\n        new Error(\n          'The facility grouping update must be a well-formed object with the data you wish to update.'\n        )\n      );\n    }\n\n    const formattedUpdate = toSnakeCase(update, {\n      excludeKeys: ['id', 'organizationId', 'ownerId']\n    });\n\n    return this._request\n      .put(`${this._baseUrl}/groupings/${facilityGroupingId}`, formattedUpdate)\n      .then((grouping) => toCamelCase(grouping));\n  }\n}\n\nexport default FacilityGroupings;\n"]}

package/esm/facilities/index.js

@@ -1,343 +0,0 @@
-var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-import isPlainObject from 'lodash.isplainobject';
-import FacilityGroupings from './groupings';
-import CostCenters from './costCenters';
-import { formatFacilityWithInfoFromServer } from '../utils/facilities';
-import { toCamelCase, toSnakeCase } from '../utils/objects';
-
-/**
- * @typedef {Object} Facility
- * @property {string} [address1]
- * @property {string} [address2]
- * @property {string} [assetId] UUID corresponding with an asset
- * @property {string} [city]
- * @property {string} createdAt ISO 8601 Extended Format date/time string
- * @property {string} [geometryId] UUID corresponding with a geometry
- * @property {number} id
- * @property {Object} [Info] User declared information
- * @property {string} name
- * @property {Object} [Organization]
- * @property {string} [Organization.createdAt] ISO 8601 Extended Format date/time string
- * @property {string} [Organization.id] UUID formatted ID
- * @property {string} [Organization.name]
- * @property {string} [Organization.updatedAt] ISO 8601 Extended Format date/time string
- * @property {string} [state]
- * @property {Object[]} [tags]
- * @property {string} [tags[].createdAt] ISO 8601 Extended Format date/time string
- * @property {number} [tags[].id]
- * @property {number} [tags[].facilityId]
- * @property {string} [tags[].name]
- * @property {string} [tags[].updatedAt] ISO 8601 Extended Format date/time string
- * @property {string} timezone An IANA Time Zone Database string, i.e. America/Los_Angeles
- * @property {number} [weatherLocationId]
- * @property {string} [zip] US Zip Code
- */
-
-/**
- * Module that provides access to, and the manipulation
- * of, information about different facilities
- *
- * @typicalname contxtSdk.facilities
- */
-
-var Facilities = function () {
-  /**
-   * @param {Object} sdk An instance of the SDK so the module can communicate with other modules
-   * @param {Object} request An instance of the request module tied to this module's audience.
-   */
-  function Facilities(sdk, request) {
-    _classCallCheck(this, Facilities);
-
-    var baseUrl = sdk.config.audiences.facilities.host + '/v1';
-
-    this._baseUrl = baseUrl;
-    this._request = request;
-    this._sdk = sdk;
-
-    this.groupings = new FacilityGroupings(sdk, request, baseUrl);
-    this.costCenters = new CostCenters(sdk, request, baseUrl);
-  }
-
-  /**
-   * Creates a new facility
-   *
-   * API Endpoint: '/facilities'
-   * Method: POST
-   *
-   * @param {Object} facility
-   * @param {string} [facility.address1]
-   * @param {string} [facility.address2]
-   * @param {string} [facility.assetId] UUID corresponding with an asset
-   * @param {string} [facility.city]
-   * @param {string} [facility.geometryId] UUID corresponding with a geometry
-   * @param {string} facility.name
-   * @param {string} facility.organizationId UUID corresponding with an organization
-   * @param {string} [facility.state]
-   * @param {string} facility.timezone
-   * @param {number} [facility.weatherLocationId]
-   * @param {string} [facility.zip]
-   *
-   * @returns {Promise}
-   * @fulfill {Facility} Information about the new facility
-   * @reject {Error}
-   *
-   * @example
-   * contxtSdk.facilities
-   *   .create({
-   *     address: '221 B Baker St, London, England',
-   *     name: 'Sherlock Holmes Museum',
-   *     organizationId: 25
-   *   })
-   *   .then((facilities) => console.log(facilities))
-   *   .catch((err) => console.log(err));
-   */
-
-
-  _createClass(Facilities, [{
-    key: 'create',
-    value: function create() {
-      var facility = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
-      var requiredFields = ['organizationId', 'name', 'timezone'];
-
-      for (var i = 0; i < requiredFields.length; i++) {
-        var field = requiredFields[i];
-
-        if (!facility[field]) {
-          return Promise.reject(new Error('A ' + field + ' is required to create a new facility.'));
-        }
-      }
-
-      return this._request.post(this._baseUrl + '/facilities', toSnakeCase(facility)).then(function (facility) {
-        return toCamelCase(facility);
-      });
-    }
-
-    /**
-     * Creates or updates a facility's info (NOTE: This refers to the facility_info model)
-     *
-     * API Endpoint: '/facilities/:facilityId/info?should_update=true'
-     * Method: POST
-     *
-     * @param {number} facilityId The ID of the facility to update
-     * @param {Object} update An object containing the facility info for the facility
-     *
-     * @returns {Promise}
-     * @fulfill {undefined}
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.facilities.createOrUpdateInfo(25, {
-     *   square_feet: '10000'
-     * });
-     */
-
-  }, {
-    key: 'createOrUpdateInfo',
-    value: function createOrUpdateInfo(facilityId, update) {
-      if (!facilityId) {
-        return Promise.reject(new Error("A facility ID is required to update a facility's info."));
-      }
-
-      if (!update) {
-        return Promise.reject(new Error("An update is required to update a facility's info."));
-      }
-
-      if (!isPlainObject(update)) {
-        return Promise.reject(new Error('The facility info update must be a well-formed object with the data you wish to update.'));
-      }
-
-      var options = {
-        params: {
-          should_update: true
-        }
-      };
-
-      return this._request.post(this._baseUrl + '/facilities/' + facilityId + '/info', update, options);
-    }
-
-    /**
-     * Deletes a facility
-     *
-     * API Endpoint: '/facilities/:facilityId'
-     * Method: DELETE
-     *
-     * @param {number} facilityId The ID of the facility
-     *
-     * @returns {Promise}
-     * @fulfill {undefined}
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.facilities.delete(25);
-     */
-
-  }, {
-    key: 'delete',
-    value: function _delete(facilityId) {
-      if (!facilityId) {
-        return Promise.reject(new Error('A facility ID is required for deleting a facility'));
-      }
-
-      return this._request.delete(this._baseUrl + '/facilities/' + facilityId);
-    }
-
-    /**
-     * Gets information about a facility
-     *
-     * API Endpoint: '/facilities/:facilityId'
-     * Method: GET
-     *
-     * @param {number} facilityId The ID of the facility
-     *
-     * @returns {Promise}
-     * @fulfill {Facility} Information about a facility
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.facilities
-     *   .get(25)
-     *   .then((facility) => console.log(facility))
-     *   .catch((err) => console.log(err));
-     */
-
-  }, {
-    key: 'get',
-    value: function get(facilityId) {
-      if (!facilityId) {
-        return Promise.reject(new Error('A facility ID is required for getting information about a facility'));
-      }
-
-      return this._request.get(this._baseUrl + '/facilities/' + facilityId).then(function (facility) {
-        return formatFacilityWithInfoFromServer(facility);
-      });
-    }
-
-    /**
-     * Gets a list of all facilities
-     *
-     * API Endpoint: '/facilities'
-     * Method: GET
-     *
-     * @returns {Promise}
-     * @fulfill {Facility[]} Information about all facilities
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.facilities
-     *   .getAll()
-     *   .then((facilities) => console.log(facilities))
-     *   .catch((err) => console.log(err));
-     */
-
-  }, {
-    key: 'getAll',
-    value: function getAll() {
-      return this._request.get(this._baseUrl + '/facilities').then(function (facilities) {
-        return facilities.map(function (facility) {
-          return formatFacilityWithInfoFromServer(facility);
-        });
-      });
-    }
-
-    /**
-     * Gets a list of all facilities that belong to a particular organization
-     *
-     * API Endpoint: '/organizations/:organizationId/facilities'
-     * Method: GET
-     *
-     * @param {string} organizationId UUID corresponding with an organization
-     * @param {object} [options] Object containing parameters to be called with the request
-     * @param {boolean} [options.includeGroupings] Boolean flag for including groupings data with each facility
-     *
-     * @returns {Promise}
-     * @fulfill {Facility[]} Information about all facilities
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.facilities
-     *   .getAllByOrganizationId(25, { includeGroupings: true })
-     *   .then((facilities) => console.log(facilities))
-     *   .catch((err) => console.log(err));
-     */
-
-  }, {
-    key: 'getAllByOrganizationId',
-    value: function getAllByOrganizationId(organizationId, options) {
-      if (!organizationId) {
-        return Promise.reject(new Error("An organization ID is required for getting a list of an organization's facilities"));
-      }
-
-      return this._request.get(this._baseUrl + '/organizations/' + organizationId + '/facilities', {
-        params: toSnakeCase(options)
-      }).then(function (facilities) {
-        return facilities.map(function (facility) {
-          return formatFacilityWithInfoFromServer(facility);
-        });
-      });
-    }
-
-    /**
-     * Updates a facility's specifics
-     *
-     * API Endpoint: '/facilities/:facilityId'
-     * Method: PUT
-     *
-     * @param {number} facilityId The ID of the facility to update
-     * @param {Object} update An object containing the updated data for the facility
-     * @param {string} [update.address1]
-     * @param {string} [update.address2]
-     * @param {string} [update.assetId] UUID corresponding with an asset
-     * @param {string} [update.city]
-     * @param {string} [update.geometryId] UUID corresponding with a geometry
-     * @param {Object} [update.info] User declared information
-     * @param {string} [update.name]
-     * @param {string} [update.organizationId] UUID corresponding with an organization
-     * @param {string} [update.state]
-     * @param {string} [update.timezone]
-     * @param {number} [update.weatherLocationId]
-     * @param {string} [update.zip]
-     *
-     * @returns {Promise}
-     * @fulfill {undefined}
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.facilities.update(25, {
-     *   address: '221 B Baker St, London, England',
-     *   name: 'Sherlock Homes Museum',
-     *   organizationId: 25
-     * });
-     */
-
-  }, {
-    key: 'update',
-    value: function update(facilityId, _update) {
-      if (!facilityId) {
-        return Promise.reject(new Error('A facility ID is required to update a facility.'));
-      }
-
-      if (!_update) {
-        return Promise.reject(new Error('An update is required to update a facility.'));
-      }
-
-      if (!isPlainObject(_update)) {
-        return Promise.reject(new Error('The facility update must be a well-formed object with the data you wish to update.'));
-      }
-
-      var formattedUpdate = toSnakeCase(_update, {
-        excludeKeys: ['id', 'organizationId']
-      });
-
-      return this._request.put(this._baseUrl + '/facilities/' + facilityId, formattedUpdate);
-    }
-  }]);
-
-  return Facilities;
-}();
-
-export default Facilities;
-//# sourceMappingURL=index.js.map

package/esm/facilities/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["facilities/index.js"],"names":["isPlainObject","FacilityGroupings","CostCenters","formatFacilityWithInfoFromServer","toCamelCase","toSnakeCase","Facilities","sdk","request","baseUrl","config","audiences","facilities","host","_baseUrl","_request","_sdk","groupings","costCenters","facility","requiredFields","i","length","field","Promise","reject","Error","post","then","facilityId","update","options","params","should_update","delete","get","map","organizationId","formattedUpdate","excludeKeys","put"],"mappings":";;;;AAAA,OAAOA,aAAP,MAA0B,sBAA1B;AACA,OAAOC,iBAAP,MAA8B,aAA9B;AACA,OAAOC,WAAP,MAAwB,eAAxB;AACA,SAASC,gCAAT,QAAiD,qBAAjD;AACA,SAASC,WAAT,EAAsBC,WAAtB,QAAyC,kBAAzC;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA;;;;;;;IAMMC,U;AACJ;;;;AAIA,sBAAYC,GAAZ,EAAiBC,OAAjB,EAA0B;AAAA;;AACxB,QAAMC,UAAaF,IAAIG,MAAJ,CAAWC,SAAX,CAAqBC,UAArB,CAAgCC,IAA7C,QAAN;;AAEA,SAAKC,QAAL,GAAgBL,OAAhB;AACA,SAAKM,QAAL,GAAgBP,OAAhB;AACA,SAAKQ,IAAL,GAAYT,GAAZ;;AAEA,SAAKU,SAAL,GAAiB,IAAIhB,iBAAJ,CAAsBM,GAAtB,EAA2BC,OAA3B,EAAoCC,OAApC,CAAjB;AACA,SAAKS,WAAL,GAAmB,IAAIhB,WAAJ,CAAgBK,GAAhB,EAAqBC,OAArB,EAA8BC,OAA9B,CAAnB;AACD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6BAiCsB;AAAA,UAAfU,QAAe,uEAAJ,EAAI;;AACpB,UAAMC,iBAAiB,CAAC,gBAAD,EAAmB,MAAnB,EAA2B,UAA3B,CAAvB;;AAEA,WAAK,IAAIC,IAAI,CAAb,EAAgBA,IAAID,eAAeE,MAAnC,EAA2CD,GAA3C,EAAgD;AAC9C,YAAME,QAAQH,eAAeC,CAAf,CAAd;;AAEA,YAAI,CAACF,SAASI,KAAT,CAAL,EAAsB;AACpB,iBAAOC,QAAQC,MAAR,CACL,IAAIC,KAAJ,QAAeH,KAAf,4CADK,CAAP;AAGD;AACF;;AAED,aAAO,KAAKR,QAAL,CACJY,IADI,CACI,KAAKb,QADT,kBACgCT,YAAYc,QAAZ,CADhC,EAEJS,IAFI,CAEC,UAACT,QAAD;AAAA,eAAcf,YAAYe,QAAZ,CAAd;AAAA,OAFD,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;;;;uCAkBmBU,U,EAAYC,M,EAAQ;AACrC,UAAI,CAACD,UAAL,EAAiB;AACf,eAAOL,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,wDAAV,CADK,CAAP;AAGD;;AAED,UAAI,CAACI,MAAL,EAAa;AACX,eAAON,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,oDAAV,CADK,CAAP;AAGD;;AAED,UAAI,CAAC1B,cAAc8B,MAAd,CAAL,EAA4B;AAC1B,eAAON,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,yFADF,CADK,CAAP;AAKD;;AAED,UAAMK,UAAU;AACdC,gBAAQ;AACNC,yBAAe;AADT;AADM,OAAhB;;AAMA,aAAO,KAAKlB,QAAL,CAAcY,IAAd,CACF,KAAKb,QADH,oBAC0Be,UAD1B,YAELC,MAFK,EAGLC,OAHK,CAAP;AAKD;;AAED;;;;;;;;;;;;;;;;;;4BAeOF,U,EAAY;AACjB,UAAI,CAACA,UAAL,EAAiB;AACf,eAAOL,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,mDAAV,CADK,CAAP;AAGD;;AAED,aAAO,KAAKX,QAAL,CAAcmB,MAAd,CAAwB,KAAKpB,QAA7B,oBAAoDe,UAApD,CAAP;AACD;;AAED;;;;;;;;;;;;;;;;;;;;;wBAkBIA,U,EAAY;AACd,UAAI,CAACA,UAAL,EAAiB;AACf,eAAOL,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,oEADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKX,QAAL,CACJoB,GADI,CACG,KAAKrB,QADR,oBAC+Be,UAD/B,EAEJD,IAFI,CAEC,UAACT,QAAD;AAAA,eAAchB,iCAAiCgB,QAAjC,CAAd;AAAA,OAFD,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;;6BAgBS;AACP,aAAO,KAAKJ,QAAL,CACJoB,GADI,CACG,KAAKrB,QADR,kBAEJc,IAFI,CAEC,UAAChB,UAAD;AAAA,eACJA,WAAWwB,GAAX,CAAe,UAACjB,QAAD;AAAA,iBAAchB,iCAAiCgB,QAAjC,CAAd;AAAA,SAAf,CADI;AAAA,OAFD,CAAP;AAKD;;AAED;;;;;;;;;;;;;;;;;;;;;;;2CAoBuBkB,c,EAAgBN,O,EAAS;AAC9C,UAAI,CAACM,cAAL,EAAqB;AACnB,eAAOb,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,mFADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKX,QAAL,CACJoB,GADI,CACG,KAAKrB,QADR,uBACkCuB,cADlC,kBAC+D;AAClEL,gBAAQ3B,YAAY0B,OAAZ;AAD0D,OAD/D,EAIJH,IAJI,CAIC,UAAChB,UAAD;AAAA,eACJA,WAAWwB,GAAX,CAAe,UAACjB,QAAD;AAAA,iBAAchB,iCAAiCgB,QAAjC,CAAd;AAAA,SAAf,CADI;AAAA,OAJD,CAAP;AAOD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAgCOU,U,EAAYC,O,EAAQ;AACzB,UAAI,CAACD,UAAL,EAAiB;AACf,eAAOL,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,iDAAV,CADK,CAAP;AAGD;;AAED,UAAI,CAACI,OAAL,EAAa;AACX,eAAON,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,6CAAV,CADK,CAAP;AAGD;;AAED,UAAI,CAAC1B,cAAc8B,OAAd,CAAL,EAA4B;AAC1B,eAAON,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,oFADF,CADK,CAAP;AAKD;;AAED,UAAMY,kBAAkBjC,YAAYyB,OAAZ,EAAoB;AAC1CS,qBAAa,CAAC,IAAD,EAAO,gBAAP;AAD6B,OAApB,CAAxB;;AAIA,aAAO,KAAKxB,QAAL,CAAcyB,GAAd,CACF,KAAK1B,QADH,oBAC0Be,UAD1B,EAELS,eAFK,CAAP;AAID;;;;;;AAGH,eAAehC,UAAf","file":"index.js","sourcesContent":["import isPlainObject from 'lodash.isplainobject';\nimport FacilityGroupings from './groupings';\nimport CostCenters from './costCenters';\nimport { formatFacilityWithInfoFromServer } from '../utils/facilities';\nimport { toCamelCase, toSnakeCase } from '../utils/objects';\n\n/**\n * @typedef {Object} Facility\n * @property {string} [address1]\n * @property {string} [address2]\n * @property {string} [assetId] UUID corresponding with an asset\n * @property {string} [city]\n * @property {string} createdAt ISO 8601 Extended Format date/time string\n * @property {string} [geometryId] UUID corresponding with a geometry\n * @property {number} id\n * @property {Object} [Info] User declared information\n * @property {string} name\n * @property {Object} [Organization]\n * @property {string} [Organization.createdAt] ISO 8601 Extended Format date/time string\n * @property {string} [Organization.id] UUID formatted ID\n * @property {string} [Organization.name]\n * @property {string} [Organization.updatedAt] ISO 8601 Extended Format date/time string\n * @property {string} [state]\n * @property {Object[]} [tags]\n * @property {string} [tags[].createdAt] ISO 8601 Extended Format date/time string\n * @property {number} [tags[].id]\n * @property {number} [tags[].facilityId]\n * @property {string} [tags[].name]\n * @property {string} [tags[].updatedAt] ISO 8601 Extended Format date/time string\n * @property {string} timezone An IANA Time Zone Database string, i.e. America/Los_Angeles\n * @property {number} [weatherLocationId]\n * @property {string} [zip] US Zip Code\n */\n\n/**\n * Module that provides access to, and the manipulation\n * of, information about different facilities\n *\n * @typicalname contxtSdk.facilities\n */\nclass Facilities {\n  /**\n   * @param {Object} sdk An instance of the SDK so the module can communicate with other modules\n   * @param {Object} request An instance of the request module tied to this module's audience.\n   */\n  constructor(sdk, request) {\n    const baseUrl = `${sdk.config.audiences.facilities.host}/v1`;\n\n    this._baseUrl = baseUrl;\n    this._request = request;\n    this._sdk = sdk;\n\n    this.groupings = new FacilityGroupings(sdk, request, baseUrl);\n    this.costCenters = new CostCenters(sdk, request, baseUrl);\n  }\n\n  /**\n   * Creates a new facility\n   *\n   * API Endpoint: '/facilities'\n   * Method: POST\n   *\n   * @param {Object} facility\n   * @param {string} [facility.address1]\n   * @param {string} [facility.address2]\n   * @param {string} [facility.assetId] UUID corresponding with an asset\n   * @param {string} [facility.city]\n   * @param {string} [facility.geometryId] UUID corresponding with a geometry\n   * @param {string} facility.name\n   * @param {string} facility.organizationId UUID corresponding with an organization\n   * @param {string} [facility.state]\n   * @param {string} facility.timezone\n   * @param {number} [facility.weatherLocationId]\n   * @param {string} [facility.zip]\n   *\n   * @returns {Promise}\n   * @fulfill {Facility} Information about the new facility\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities\n   *   .create({\n   *     address: '221 B Baker St, London, England',\n   *     name: 'Sherlock Holmes Museum',\n   *     organizationId: 25\n   *   })\n   *   .then((facilities) => console.log(facilities))\n   *   .catch((err) => console.log(err));\n   */\n  create(facility = {}) {\n    const requiredFields = ['organizationId', 'name', 'timezone'];\n\n    for (let i = 0; i < requiredFields.length; i++) {\n      const field = requiredFields[i];\n\n      if (!facility[field]) {\n        return Promise.reject(\n          new Error(`A ${field} is required to create a new facility.`)\n        );\n      }\n    }\n\n    return this._request\n      .post(`${this._baseUrl}/facilities`, toSnakeCase(facility))\n      .then((facility) => toCamelCase(facility));\n  }\n\n  /**\n   * Creates or updates a facility's info (NOTE: This refers to the facility_info model)\n   *\n   * API Endpoint: '/facilities/:facilityId/info?should_update=true'\n   * Method: POST\n   *\n   * @param {number} facilityId The ID of the facility to update\n   * @param {Object} update An object containing the facility info for the facility\n   *\n   * @returns {Promise}\n   * @fulfill {undefined}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities.createOrUpdateInfo(25, {\n   *   square_feet: '10000'\n   * });\n   */\n  createOrUpdateInfo(facilityId, update) {\n    if (!facilityId) {\n      return Promise.reject(\n        new Error(\"A facility ID is required to update a facility's info.\")\n      );\n    }\n\n    if (!update) {\n      return Promise.reject(\n        new Error(\"An update is required to update a facility's info.\")\n      );\n    }\n\n    if (!isPlainObject(update)) {\n      return Promise.reject(\n        new Error(\n          'The facility info update must be a well-formed object with the data you wish to update.'\n        )\n      );\n    }\n\n    const options = {\n      params: {\n        should_update: true\n      }\n    };\n\n    return this._request.post(\n      `${this._baseUrl}/facilities/${facilityId}/info`,\n      update,\n      options\n    );\n  }\n\n  /**\n   * Deletes a facility\n   *\n   * API Endpoint: '/facilities/:facilityId'\n   * Method: DELETE\n   *\n   * @param {number} facilityId The ID of the facility\n   *\n   * @returns {Promise}\n   * @fulfill {undefined}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities.delete(25);\n   */\n  delete(facilityId) {\n    if (!facilityId) {\n      return Promise.reject(\n        new Error('A facility ID is required for deleting a facility')\n      );\n    }\n\n    return this._request.delete(`${this._baseUrl}/facilities/${facilityId}`);\n  }\n\n  /**\n   * Gets information about a facility\n   *\n   * API Endpoint: '/facilities/:facilityId'\n   * Method: GET\n   *\n   * @param {number} facilityId The ID of the facility\n   *\n   * @returns {Promise}\n   * @fulfill {Facility} Information about a facility\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities\n   *   .get(25)\n   *   .then((facility) => console.log(facility))\n   *   .catch((err) => console.log(err));\n   */\n  get(facilityId) {\n    if (!facilityId) {\n      return Promise.reject(\n        new Error(\n          'A facility ID is required for getting information about a facility'\n        )\n      );\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/facilities/${facilityId}`)\n      .then((facility) => formatFacilityWithInfoFromServer(facility));\n  }\n\n  /**\n   * Gets a list of all facilities\n   *\n   * API Endpoint: '/facilities'\n   * Method: GET\n   *\n   * @returns {Promise}\n   * @fulfill {Facility[]} Information about all facilities\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities\n   *   .getAll()\n   *   .then((facilities) => console.log(facilities))\n   *   .catch((err) => console.log(err));\n   */\n  getAll() {\n    return this._request\n      .get(`${this._baseUrl}/facilities`)\n      .then((facilities) =>\n        facilities.map((facility) => formatFacilityWithInfoFromServer(facility))\n      );\n  }\n\n  /**\n   * Gets a list of all facilities that belong to a particular organization\n   *\n   * API Endpoint: '/organizations/:organizationId/facilities'\n   * Method: GET\n   *\n   * @param {string} organizationId UUID corresponding with an organization\n   * @param {object} [options] Object containing parameters to be called with the request\n   * @param {boolean} [options.includeGroupings] Boolean flag for including groupings data with each facility\n   *\n   * @returns {Promise}\n   * @fulfill {Facility[]} Information about all facilities\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities\n   *   .getAllByOrganizationId(25, { includeGroupings: true })\n   *   .then((facilities) => console.log(facilities))\n   *   .catch((err) => console.log(err));\n   */\n  getAllByOrganizationId(organizationId, options) {\n    if (!organizationId) {\n      return Promise.reject(\n        new Error(\n          \"An organization ID is required for getting a list of an organization's facilities\"\n        )\n      );\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/organizations/${organizationId}/facilities`, {\n        params: toSnakeCase(options)\n      })\n      .then((facilities) =>\n        facilities.map((facility) => formatFacilityWithInfoFromServer(facility))\n      );\n  }\n\n  /**\n   * Updates a facility's specifics\n   *\n   * API Endpoint: '/facilities/:facilityId'\n   * Method: PUT\n   *\n   * @param {number} facilityId The ID of the facility to update\n   * @param {Object} update An object containing the updated data for the facility\n   * @param {string} [update.address1]\n   * @param {string} [update.address2]\n   * @param {string} [update.assetId] UUID corresponding with an asset\n   * @param {string} [update.city]\n   * @param {string} [update.geometryId] UUID corresponding with a geometry\n   * @param {Object} [update.info] User declared information\n   * @param {string} [update.name]\n   * @param {string} [update.organizationId] UUID corresponding with an organization\n   * @param {string} [update.state]\n   * @param {string} [update.timezone]\n   * @param {number} [update.weatherLocationId]\n   * @param {string} [update.zip]\n   *\n   * @returns {Promise}\n   * @fulfill {undefined}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.facilities.update(25, {\n   *   address: '221 B Baker St, London, England',\n   *   name: 'Sherlock Homes Museum',\n   *   organizationId: 25\n   * });\n   */\n  update(facilityId, update) {\n    if (!facilityId) {\n      return Promise.reject(\n        new Error('A facility ID is required to update a facility.')\n      );\n    }\n\n    if (!update) {\n      return Promise.reject(\n        new Error('An update is required to update a facility.')\n      );\n    }\n\n    if (!isPlainObject(update)) {\n      return Promise.reject(\n        new Error(\n          'The facility update must be a well-formed object with the data you wish to update.'\n        )\n      );\n    }\n\n    const formattedUpdate = toSnakeCase(update, {\n      excludeKeys: ['id', 'organizationId']\n    });\n\n    return this._request.put(\n      `${this._baseUrl}/facilities/${facilityId}`,\n      formattedUpdate\n    );\n  }\n}\n\nexport default Facilities;\n"]}

package/esm/health/index.js

@@ -1,229 +0,0 @@
-var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-import { formatPaginatedDataFromServer } from '../utils/pagination';
-
-/**
- * @typedef {Object} HealthStatus
- * @property {string} status A health status of value 'healthy' or 'unhealthy'
- * @property {string} timestamp  ISO 8601 Extended Format date/time string
- */
-
-/**
- * @typedef {Object} HealthAsset
- * @augments Asset
- * @property {HealthStatus} health
- */
-
-/**
- * @interface PaginatedResponse
- * @template RecordType
- * @typedef {Object} PaginatedResponse
- * @property {Object} _metadata Metadata about the pagination settings
- * @property {number} _metadata.offset Offset of records in subsequent queries
- * @property {number} _metadata.totalRecords Total number of asset types found
- * @property {Array.<RecordType>} records
- */
-
-/**
- * @typedef {PaginatedResponse.<HealthAsset>} HealthAssetPaginatedResponse
- */
-
-/**
- * @typedef {PaginatedResponse.<HealthStatus>} HealthStatusPaginatedResponse
- */
-
-/**
- * Module that provides access to the Contxt Health Service
- *
- * @typicalname contxtSdk.health
- */
-
-var Health = function () {
-  /**
-   * @param {Object} sdk An instance of the SDK so the module can communicate with other modules
-   * @param {Object} request An instance of the request module tied to this module's audience.
-   * @param {string} [organizationId] The organization ID to be used in tenant url requests
-   */
-  function Health(sdk, request) {
-    var organizationId = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
-
-    _classCallCheck(this, Health);
-
-    var baseUrl = sdk.config.audiences.health.host + '/v1';
-
-    this._baseUrl = baseUrl;
-    this._request = request;
-    this._sdk = sdk;
-
-    this._organizationId = organizationId;
-  }
-
-  /**
-   * The health status option constants
-   * @enum {string}
-   * @static
-   * @example
-   * console.log(Health.GOOD) //healthy
-   * console.log(Health.BAD) //unhealthy
-   */
-
-
-  _createClass(Health, [{
-    key: 'getAll',
-
-
-    /**
-     * Gets all of an organization's assets and their most recent health status
-     *
-     * API Endpoint: '/:organizationId/assets'
-     * Method: GET
-     *
-     * @param {Object} options
-     * @param {string} [options.organizationId] The organization id that owns the assets. Required if an organization id isn't set on the module instance.
-     * @param {PaginationOptions} [paginationOptions]
-     * @returns {Promise}
-     * @fulfill {HealthAssetPaginatedResponse} Information about all contxt applications
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.health
-     *   .getAll({
-     *      organizationId: 'bd900b6e-a319-492f-aa95-9715891b9a83'
-     *    }, {
-     *      limit: 50,
-     *      offset: 100
-     *   })
-     *   .then((healthAssetRecords) => console.log(healthAssetRecords))
-     *   .catch((err) => console.log(err));
-     */
-    value: function getAll(_ref, paginationOptions) {
-      var _ref$organizationId = _ref.organizationId,
-          organizationId = _ref$organizationId === undefined ? this._organizationId : _ref$organizationId;
-
-      if (!organizationId) {
-        return Promise.reject(new Error('An organization ID is required'));
-      }
-
-      return this._request.get(this._baseUrl + '/' + organizationId + '/assets', {
-        params: paginationOptions
-      }).then(function (response) {
-        return formatPaginatedDataFromServer(response);
-      });
-    }
-
-    /**
-     * Gets a list of health statuses for a single asset
-     *
-     * API Endpoint: '/:organizationId/assets/:assetId'
-     * Method: GET
-     *
-     * @param {Object} options
-     * @param {string} options.assetId The asset id to get the health for
-     * @param {string} [options.organizationId] The organization id that owns the assets. Required if an organization id isn't set on the module instance.
-     * @param {PaginationOptions} [paginationOptions]
-     * @returns {Promise}
-     * @fulfill {HealthStatusPaginatedResponse} Information about all contxt applications
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.health
-     *   .getByAssetId({
-     *      assetId: '9859f22d-cc45-4015-8674-1671f54d1888',
-     *      organizationId: 'bd900b6e-a319-492f-aa95-9715891b9a83'
-     *   }, {
-     *      limit: 50,
-     *      offset: 100
-     *   })
-     *   .then((healthStatusRecords) => console.log(healthStatusRecords))
-     *   .catch((err) => console.log(err));
-     */
-
-  }, {
-    key: 'getByAssetId',
-    value: function getByAssetId(_ref2, paginationOptions) {
-      var assetId = _ref2.assetId,
-          _ref2$organizationId = _ref2.organizationId,
-          organizationId = _ref2$organizationId === undefined ? this._organizationId : _ref2$organizationId;
-
-      if (!assetId) {
-        return Promise.reject(new Error('An asset ID is required'));
-      }
-
-      if (!organizationId) {
-        return Promise.reject(new Error('An organization ID is required'));
-      }
-
-      return this._request.get(this._baseUrl + '/' + organizationId + '/assets/' + assetId, {
-        params: paginationOptions
-      }).then(function (response) {
-        return formatPaginatedDataFromServer(response);
-      });
-    }
-
-    /**
-     * Creates a new health status entry for an asset
-     *
-     * API Endpoint: '/:organizationId/assets/:assetId'
-     * Method: POST
-     *
-     * @param {Object} options
-     * @param {string} options.assetId The asset id to get the health for
-     * @param {string} [options.organizationId] The organization id that owns the assets. Required if an organization id isn't set on the module instance.
-     * @param {string} options.status The health of the asset. One of type Health.status.GOOD or Health.status.BAD
-     * @param {string} [options.timestamp] Defaults to now. ISO 8601 Extended Format date/time string
-     * @returns {Promise}
-     * @fulfill {HealthStatusPaginatedResponse} Information about all contxt applications
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.health
-     *   .post({
-     *      assetId: '9859f22d-cc45-4015-8674-1671f54d1888',
-     *      organizationId: 'bd900b6e-a319-492f-aa95-9715891b9a83',
-     *      status: contxtSdk.health.status.GOOD
-     *   })
-     *   .then((healthStatus) => console.log(healthStatus))
-     *   .catch((err) => console.log(err));
-     */
-
-  }, {
-    key: 'post',
-    value: function post(_ref3) {
-      var assetId = _ref3.assetId,
-          _ref3$organizationId = _ref3.organizationId,
-          organizationId = _ref3$organizationId === undefined ? this._organizationId : _ref3$organizationId,
-          status = _ref3.status,
-          timestamp = _ref3.timestamp;
-
-      if (!assetId) {
-        return Promise.reject(new Error('An asset ID is required'));
-      }
-
-      if (!organizationId) {
-        return Promise.reject(new Error('An organization ID is required'));
-      }
-
-      if (!Object.values(Health.status).includes(status)) {
-        return Promise.reject(new Error('Status must equal one of: ' + Object.values(Health.status).join(', ')));
-      }
-
-      return this._request.post(this._baseUrl + '/' + organizationId + '/assets/' + assetId, {
-        status: status,
-        timestamp: timestamp
-      });
-    }
-  }]);
-
-  return Health;
-}();
-
-Health.status = {
-  GOOD: 'healthy',
-  BAD: 'unhealthy'
-};
-
-
-export default Health;
-//# sourceMappingURL=index.js.map

package/esm/health/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["health/index.js"],"names":["formatPaginatedDataFromServer","Health","sdk","request","organizationId","baseUrl","config","audiences","health","host","_baseUrl","_request","_sdk","_organizationId","paginationOptions","Promise","reject","Error","get","params","then","response","assetId","status","timestamp","Object","values","includes","join","post","GOOD","BAD"],"mappings":";;;;AAAA,SAASA,6BAAT,QAA8C,qBAA9C;;AAEA;;;;;;AAMA;;;;;;AAMA;;;;;;;;;;AAUA;;;;AAIA;;;;AAIA;;;;;;IAKMC,M;AACJ;;;;;AAKA,kBAAYC,GAAZ,EAAiBC,OAAjB,EAAiD;AAAA,QAAvBC,cAAuB,uEAAN,IAAM;;AAAA;;AAC/C,QAAMC,UAAaH,IAAII,MAAJ,CAAWC,SAAX,CAAqBC,MAArB,CAA4BC,IAAzC,QAAN;;AAEA,SAAKC,QAAL,GAAgBL,OAAhB;AACA,SAAKM,QAAL,GAAgBR,OAAhB;AACA,SAAKS,IAAL,GAAYV,GAAZ;;AAEA,SAAKW,eAAL,GAAuBT,cAAvB;AACD;;AAED;;;;;;;;;;;;;;AAaA;;;;;;;;;;;;;;;;;;;;;;;;iCAwBkDU,iB,EAAmB;AAAA,qCAA5DV,cAA4D;AAAA,UAA5DA,cAA4D,uCAA3C,KAAKS,eAAsC;;AACnE,UAAI,CAACT,cAAL,EAAqB;AACnB,eAAOW,QAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAU,gCAAV,CAAf,CAAP;AACD;;AAED,aAAO,KAAKN,QAAL,CACJO,GADI,CACG,KAAKR,QADR,SACoBN,cADpB,cAC6C;AAChDe,gBAAQL;AADwC,OAD7C,EAIJM,IAJI,CAIC,UAACC,QAAD;AAAA,eAAcrB,8BAA8BqB,QAA9B,CAAd;AAAA,OAJD,CAAP;AAKD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wCA4BEP,iB,EACA;AAAA,UAFEQ,OAEF,SAFEA,OAEF;AAAA,uCAFWlB,cAEX;AAAA,UAFWA,cAEX,wCAF4B,KAAKS,eAEjC;;AACA,UAAI,CAACS,OAAL,EAAc;AACZ,eAAOP,QAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAU,yBAAV,CAAf,CAAP;AACD;;AAED,UAAI,CAACb,cAAL,EAAqB;AACnB,eAAOW,QAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAU,gCAAV,CAAf,CAAP;AACD;;AAED,aAAO,KAAKN,QAAL,CACJO,GADI,CACG,KAAKR,QADR,SACoBN,cADpB,gBAC6CkB,OAD7C,EACwD;AAC3DH,gBAAQL;AADmD,OADxD,EAIJM,IAJI,CAIC,UAACC,QAAD;AAAA,eAAcrB,8BAA8BqB,QAA9B,CAAd;AAAA,OAJD,CAAP;AAKD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAyB4E;AAAA,UAArEC,OAAqE,SAArEA,OAAqE;AAAA,uCAA5DlB,cAA4D;AAAA,UAA5DA,cAA4D,wCAA3C,KAAKS,eAAsC;AAAA,UAArBU,MAAqB,SAArBA,MAAqB;AAAA,UAAbC,SAAa,SAAbA,SAAa;;AAC1E,UAAI,CAACF,OAAL,EAAc;AACZ,eAAOP,QAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAU,yBAAV,CAAf,CAAP;AACD;;AAED,UAAI,CAACb,cAAL,EAAqB;AACnB,eAAOW,QAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAU,gCAAV,CAAf,CAAP;AACD;;AAED,UAAI,CAACQ,OAAOC,MAAP,CAAczB,OAAOsB,MAArB,EAA6BI,QAA7B,CAAsCJ,MAAtC,CAAL,EAAoD;AAClD,eAAOR,QAAQC,MAAR,CACL,IAAIC,KAAJ,gCAC+BQ,OAAOC,MAAP,CAAczB,OAAOsB,MAArB,EAA6BK,IAA7B,CAAkC,IAAlC,CAD/B,CADK,CAAP;AAKD;;AAED,aAAO,KAAKjB,QAAL,CAAckB,IAAd,CACF,KAAKnB,QADH,SACeN,cADf,gBACwCkB,OADxC,EAEL;AACEC,sBADF;AAEEC;AAFF,OAFK,CAAP;AAOD;;;;;;AA/JGvB,M,CAwBGsB,M,GAAS;AACdO,QAAM,SADQ;AAEdC,OAAK;AAFS,C;;;AA0IlB,eAAe9B,MAAf","file":"index.js","sourcesContent":["import { formatPaginatedDataFromServer } from '../utils/pagination';\n\n/**\n * @typedef {Object} HealthStatus\n * @property {string} status A health status of value 'healthy' or 'unhealthy'\n * @property {string} timestamp  ISO 8601 Extended Format date/time string\n */\n\n/**\n * @typedef {Object} HealthAsset\n * @augments Asset\n * @property {HealthStatus} health\n */\n\n/**\n * @interface PaginatedResponse\n * @template RecordType\n * @typedef {Object} PaginatedResponse\n * @property {Object} _metadata Metadata about the pagination settings\n * @property {number} _metadata.offset Offset of records in subsequent queries\n * @property {number} _metadata.totalRecords Total number of asset types found\n * @property {Array.<RecordType>} records\n */\n\n/**\n * @typedef {PaginatedResponse.<HealthAsset>} HealthAssetPaginatedResponse\n */\n\n/**\n * @typedef {PaginatedResponse.<HealthStatus>} HealthStatusPaginatedResponse\n */\n\n/**\n * Module that provides access to the Contxt Health Service\n *\n * @typicalname contxtSdk.health\n */\nclass Health {\n  /**\n   * @param {Object} sdk An instance of the SDK so the module can communicate with other modules\n   * @param {Object} request An instance of the request module tied to this module's audience.\n   * @param {string} [organizationId] The organization ID to be used in tenant url requests\n   */\n  constructor(sdk, request, organizationId = null) {\n    const baseUrl = `${sdk.config.audiences.health.host}/v1`;\n\n    this._baseUrl = baseUrl;\n    this._request = request;\n    this._sdk = sdk;\n\n    this._organizationId = organizationId;\n  }\n\n  /**\n   * The health status option constants\n   * @enum {string}\n   * @static\n   * @example\n   * console.log(Health.GOOD) //healthy\n   * console.log(Health.BAD) //unhealthy\n   */\n  static status = {\n    GOOD: 'healthy',\n    BAD: 'unhealthy'\n  };\n\n  /**\n   * Gets all of an organization's assets and their most recent health status\n   *\n   * API Endpoint: '/:organizationId/assets'\n   * Method: GET\n   *\n   * @param {Object} options\n   * @param {string} [options.organizationId] The organization id that owns the assets. Required if an organization id isn't set on the module instance.\n   * @param {PaginationOptions} [paginationOptions]\n   * @returns {Promise}\n   * @fulfill {HealthAssetPaginatedResponse} Information about all contxt applications\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.health\n   *   .getAll({\n   *      organizationId: 'bd900b6e-a319-492f-aa95-9715891b9a83'\n   *    }, {\n   *      limit: 50,\n   *      offset: 100\n   *   })\n   *   .then((healthAssetRecords) => console.log(healthAssetRecords))\n   *   .catch((err) => console.log(err));\n   */\n  getAll({ organizationId = this._organizationId }, paginationOptions) {\n    if (!organizationId) {\n      return Promise.reject(new Error('An organization ID is required'));\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/${organizationId}/assets`, {\n        params: paginationOptions\n      })\n      .then((response) => formatPaginatedDataFromServer(response));\n  }\n\n  /**\n   * Gets a list of health statuses for a single asset\n   *\n   * API Endpoint: '/:organizationId/assets/:assetId'\n   * Method: GET\n   *\n   * @param {Object} options\n   * @param {string} options.assetId The asset id to get the health for\n   * @param {string} [options.organizationId] The organization id that owns the assets. Required if an organization id isn't set on the module instance.\n   * @param {PaginationOptions} [paginationOptions]\n   * @returns {Promise}\n   * @fulfill {HealthStatusPaginatedResponse} Information about all contxt applications\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.health\n   *   .getByAssetId({\n   *      assetId: '9859f22d-cc45-4015-8674-1671f54d1888',\n   *      organizationId: 'bd900b6e-a319-492f-aa95-9715891b9a83'\n   *   }, {\n   *      limit: 50,\n   *      offset: 100\n   *   })\n   *   .then((healthStatusRecords) => console.log(healthStatusRecords))\n   *   .catch((err) => console.log(err));\n   */\n  getByAssetId(\n    { assetId, organizationId = this._organizationId },\n    paginationOptions\n  ) {\n    if (!assetId) {\n      return Promise.reject(new Error('An asset ID is required'));\n    }\n\n    if (!organizationId) {\n      return Promise.reject(new Error('An organization ID is required'));\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/${organizationId}/assets/${assetId}`, {\n        params: paginationOptions\n      })\n      .then((response) => formatPaginatedDataFromServer(response));\n  }\n\n  /**\n   * Creates a new health status entry for an asset\n   *\n   * API Endpoint: '/:organizationId/assets/:assetId'\n   * Method: POST\n   *\n   * @param {Object} options\n   * @param {string} options.assetId The asset id to get the health for\n   * @param {string} [options.organizationId] The organization id that owns the assets. Required if an organization id isn't set on the module instance.\n   * @param {string} options.status The health of the asset. One of type Health.status.GOOD or Health.status.BAD\n   * @param {string} [options.timestamp] Defaults to now. ISO 8601 Extended Format date/time string\n   * @returns {Promise}\n   * @fulfill {HealthStatusPaginatedResponse} Information about all contxt applications\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.health\n   *   .post({\n   *      assetId: '9859f22d-cc45-4015-8674-1671f54d1888',\n   *      organizationId: 'bd900b6e-a319-492f-aa95-9715891b9a83',\n   *      status: contxtSdk.health.status.GOOD\n   *   })\n   *   .then((healthStatus) => console.log(healthStatus))\n   *   .catch((err) => console.log(err));\n   */\n  post({ assetId, organizationId = this._organizationId, status, timestamp }) {\n    if (!assetId) {\n      return Promise.reject(new Error('An asset ID is required'));\n    }\n\n    if (!organizationId) {\n      return Promise.reject(new Error('An organization ID is required'));\n    }\n\n    if (!Object.values(Health.status).includes(status)) {\n      return Promise.reject(\n        new Error(\n          `Status must equal one of: ${Object.values(Health.status).join(', ')}`\n        )\n      );\n    }\n\n    return this._request.post(\n      `${this._baseUrl}/${organizationId}/assets/${assetId}`,\n      {\n        status,\n        timestamp\n      }\n    );\n  }\n}\n\nexport default Health;\n"]}