@ndustrial/contxt-sdk 4.3.6 → 5.2.0

package/lib/assets/assetMetrics.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["assets/assetMetrics.js"],"names":["AssetMetrics","sdk","request","baseUrl","_baseUrl","_request","_sdk","assetTypeId","assetMetric","Promise","reject","Error","hasFieldFns","default","object","key","organizationId","requiredFields","i","length","field","hasField","post","then","assetMetricId","delete","get","assetId","assetMetricsFilters","params","assetMetricsData","update","formattedUpdate","excludeKeys","put","assetMetricValue","assetMetricValueId","assetMetricValuesFilters","assetMetricValueData","assetMetricFilters","paramsSerializer","stringifyParamsWithCommaSeparatedArrays","assetMetricValues","result","excludeTransform","labels","assetIds"],"mappings":";;;;;;;;AAAA;;;;AACA;;;;AACA;;AACA;;AACA;;;;;;;;AAEA;;;;;;;;;;;;;AAaA;;;;;;;;AAQA;;;;;;;;;;;;;;AAcA;;;;;;;;AAQA;;;;;;;;;AASA;;;;AAIA;;;;;;;;;;;;;;;;;;;;AAoBA;;;;;IAKMA,Y;AACJ;;;;;AAKA,wBAAYC,GAAZ,EAAiBC,OAAjB,EAA0BC,OAA1B,EAAmC;AAAA;;AACjC,SAAKC,QAAL,GAAgBD,OAAhB;AACA,SAAKE,QAAL,GAAgBH,OAAhB;AACA,SAAKI,IAAL,GAAYL,GAAZ;AACD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BA8BOM,W,EAA+B;AAAA,UAAlBC,WAAkB,uEAAJ,EAAI;;AACpC,UAAI,CAACD,WAAL,EAAkB;AAChB,eAAOE,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,yDAAV,CADK,CAAP;AAGD;;AAED,UAAMC,cAAc;AAClBC,iBAAS,kBAACC,MAAD,EAASC,GAAT;AAAA,iBAAiB,CAAC,CAACD,OAAOC,GAAP,CAAnB;AAAA,SADS;AAElBC,wBAAgB,wBAACF,MAAD,EAASC,GAAT;AAAA,iBAAiB,sBAAID,MAAJ,EAAYC,GAAZ,CAAjB;AAAA;AAFE,OAApB;AAIA,UAAME,iBAAiB,CACrB,aADqB,EAErB,OAFqB,EAGrB,gBAHqB,EAIrB,cAJqB,CAAvB;;AAOA,WAAK,IAAIC,IAAI,CAAb,EAAgBA,IAAID,eAAeE,MAAnC,EAA2CD,GAA3C,EAAgD;AAC9C,YAAME,QAAQH,eAAeC,CAAf,CAAd;AACA,YAAMG,WAAWT,YAAYQ,KAAZ,KAAsBR,YAAYC,OAAnD;;AAEA,YAAI,CAACQ,SAASb,WAAT,EAAsBY,KAAtB,CAAL,EAAmC;AACjC,iBAAOX,QAAQC,MAAR,CACL,IAAIC,KAAJ,QAAeS,KAAf,gDADK,CAAP;AAGD;AACF;;AAED,aAAO,KAAKf,QAAL,CACJiB,IADI,CAEA,KAAKlB,QAFL,sBAE8BG,WAF9B,eAGH,0BAAYC,WAAZ,CAHG,EAKJe,IALI,CAKC,UAACf,WAAD;AAAA,eAAiB,0BAAYA,WAAZ,CAAjB;AAAA,OALD,CAAP;AAMD;;AAED;;;;;;;;;;;;;;;;;;4BAeOgB,a,EAAe;AACpB,UAAI,CAACA,aAAL,EAAoB;AAClB,eAAOf,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,8DADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKN,QAAL,CAAcoB,MAAd,CACF,KAAKrB,QADH,wBAC8BoB,aAD9B,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;;;;wBAkBIA,a,EAAe;AACjB,UAAI,CAACA,aAAL,EAAoB;AAClB,eAAOf,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,+EADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKN,QAAL,CACJqB,GADI,CACG,KAAKtB,QADR,wBACmCoB,aADnC,EAEJD,IAFI,CAEC,UAACf,WAAD;AAAA,eAAiB,0BAAYA,WAAZ,CAAjB;AAAA,OAFD,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAiCamB,O,EAASC,mB,EAAqB;AACzC,UAAI,CAACD,OAAL,EAAc;AACZ,eAAOlB,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,6DAAV,CADK,CAAP;AAGD;;AAED,aAAO,KAAKN,QAAL,CACJqB,GADI,CACG,KAAKtB,QADR,gBAC2BuB,OAD3B,eAC8C;AACjDE,gBAAQ,0BAAYD,mBAAZ;AADyC,OAD9C,EAIJL,IAJI,CAIC,UAACO,gBAAD;AAAA,eACJ,+CAA8BA,gBAA9B,CADI;AAAA,OAJD,CAAP;AAOD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCAgCiBvB,W,EAAaqB,mB,EAAqB;AACjD,UAAI,CAACrB,WAAL,EAAkB;AAChB,eAAOE,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,kEADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKN,QAAL,CACJqB,GADI,CACG,KAAKtB,QADR,sBACiCG,WADjC,eACwD;AAC3DsB,gBAAQ,0BAAYD,mBAAZ;AADmD,OADxD,EAIJL,IAJI,CAIC,UAACO,gBAAD;AAAA,eACJ,+CAA8BA,gBAA9B,CADI;AAAA,OAJD,CAAP;AAOD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;2BAuBON,a,EAAeO,O,EAAQ;AAC5B,UAAI,CAACP,aAAL,EAAoB;AAClB,eAAOf,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,2DAAV,CADK,CAAP;AAGD;;AAED,UAAI,CAACoB,OAAL,EAAa;AACX,eAAOtB,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,kDAAV,CADK,CAAP;AAGD;;AAED,UAAI,CAAC,sBAAcoB,OAAd,CAAL,EAA4B;AAC1B,eAAOtB,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,wFADF,CADK,CAAP;AAKD;;AAED,UAAMqB,kBAAkB,0BAAYD,OAAZ,EAAoB;AAC1CE,qBAAa,CAAC,WAAD,EAAc,IAAd,EAAoB,OAApB,EAA6B,gBAA7B,EAA+C,WAA/C;AAD6B,OAApB,CAAxB;;AAIA,aAAO,KAAK5B,QAAL,CAAc6B,GAAd,CACF,KAAK9B,QADH,wBAC8BoB,aAD9B,EAELQ,eAFK,CAAP;AAID;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAoCYL,O,EAAgC;AAAA,UAAvBQ,gBAAuB,uEAAJ,EAAI;;AAC1C,UAAMlB,iBAAiB,CACrB,eADqB,EAErB,kBAFqB,EAGrB,oBAHqB,EAIrB,OAJqB,CAAvB;;AAOA,UAAI,CAACU,OAAL,EAAc;AACZ,eAAOlB,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,6DAAV,CADK,CAAP;AAGD;;AAED,WAAK,IAAIO,IAAI,CAAb,EAAgBA,IAAID,eAAeE,MAAnC,EAA2CD,GAA3C,EAAgD;AAC9C,YAAME,QAAQH,eAAeC,CAAf,CAAd;;AAEA,YAAI,CAACiB,iBAAiBf,KAAjB,CAAL,EAA8B;AAC5B,iBAAOX,QAAQC,MAAR,CACL,IAAIC,KAAJ,QACOS,KADP,sDADK,CAAP;AAKD;AACF;;AAED,aAAO,KAAKf,QAAL,CACJiB,IADI,CAEA,KAAKlB,QAFL,gBAEwBuB,OAFxB,iBAGDQ,iBAAiBX,aAHhB,cAKH,0BAAYW,gBAAZ,CALG,EAOJZ,IAPI,CAOC,UAACY,gBAAD;AAAA,eAAsB,0BAAYA,gBAAZ,CAAtB;AAAA,OAPD,CAAP;AAQD;;AAED;;;;;;;;;;;;;;;;;;;;gCAiBYC,kB,EAAoB;AAC9B,UAAI,CAACA,kBAAL,EAAyB;AACvB,eAAO3B,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,0EADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKN,QAAL,CAAcoB,MAAd,CACF,KAAKrB,QADH,+BACqCgC,kBADrC,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uCAuCmBT,O,EAASU,wB,EAA0B;AACpD,UAAI,CAACV,OAAL,EAAc;AACZ,eAAOlB,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,+DADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKN,QAAL,CACJqB,GADI,CACG,KAAKtB,QADR,gBAC2BuB,OAD3B,sBACqD;AACxDE,gBAAQ,0BAAYQ,wBAAZ;AADgD,OADrD,EAIJd,IAJI,CAIC,UAACe,oBAAD;AAAA,eACJ,+CAA8BA,oBAA9B,CADI;AAAA,OAJD,CAAP;AAOD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wCAuCoBX,O,EAASH,a,EAAea,wB,EAA0B;AACpE,UAAI,CAACV,OAAL,EAAc;AACZ,eAAOlB,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,+DADF,CADK,CAAP;AAKD;;AAED,UAAI,CAACa,aAAL,EAAoB;AAClB,eAAOf,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,sEADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKN,QAAL,CACJqB,GADI,CAEA,KAAKtB,QAFL,gBAEwBuB,OAFxB,iBAE2CH,aAF3C,cAGH;AACEK,gBAAQ,0BAAYQ,wBAAZ;AADV,OAHG,EAOJd,IAPI,CAOC,UAACe,oBAAD;AAAA,eACJ,+CAA8BA,oBAA9B,CADI;AAAA,OAPD,CAAP;AAUD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iDAmC6BC,kB,EAAoB;AAC/C,UAAMtB,iBAAiB,CAAC,UAAD,EAAa,QAAb,CAAvB;;AAEA,WAAK,IAAIC,IAAI,CAAb,EAAgBA,IAAID,eAAeE,MAAnC,EAA2CD,GAA3C,EAAgD;AAC9C,YAAME,QAAQH,eAAeC,CAAf,CAAd;;AAEA,YAAI,CAACqB,mBAAmBnB,KAAnB,CAAL,EAAgC;AAC9B,iBAAOX,QAAQC,MAAR,CACL,IAAIC,KAAJ,UAAiBS,KAAjB,uCADK,CAAP;AAGD;AACF;;AAED,aAAO,KAAKf,QAAL,CACJqB,GADI,CACG,KAAKtB,QADR,6BAC0C;AAC7CyB,gBAAQ,0BAAYU,kBAAZ,CADqC;AAE7CC,0BAAkBC;AAF2B,OAD1C,EAKJlB,IALI,CAKC,UAACmB,iBAAD,EAAuB;AAC3B,YAAMC,SAAS,0BAAYD,iBAAZ,EAA+B;AAC5CE,yDACKL,mBAAmBM,MADxB,sBAEKN,mBAAmBO,QAFxB;AAD4C,SAA/B,CAAf;;AAOA,eAAOH,MAAP;AACD,OAdI,CAAP;AAeD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCA4BYP,kB,EAAoBL,M,EAAQ;AACtC,UAAI,CAACK,kBAAL,EAAyB;AACvB,eAAO3B,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,uEADF,CADK,CAAP;AAKD;;AAED,UAAI,CAACoB,MAAL,EAAa;AACX,eAAOtB,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,wDAAV,CADK,CAAP;AAGD;;AAED,UAAI,CAAC,sBAAcoB,MAAd,CAAL,EAA4B;AAC1B,eAAOtB,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,8FADF,CADK,CAAP;AAKD;;AAED,UAAMqB,kBAAkB,0BAAYD,MAAZ,EAAoB;AAC1CE,qBAAa,CAAC,SAAD,EAAY,eAAZ,EAA6B,IAA7B;AAD6B,OAApB,CAAxB;;AAIA,aAAO,KAAK5B,QAAL,CAAc6B,GAAd,CACF,KAAK9B,QADH,+BACqCgC,kBADrC,EAELJ,eAFK,CAAP;AAID;;;;;;kBAGYhC,Y","file":"assetMetrics.js","sourcesContent":["import has from 'lodash.has';\nimport isPlainObject from 'lodash.isplainobject';\nimport { toCamelCase, toSnakeCase } from '../utils/objects';\nimport { stringifyParamsWithCommaSeparatedArrays } from '../utils/url';\nimport { formatPaginatedDataFromServer } from '../utils/pagination';\n\n/**\n * @typedef {Object} AssetMetric\n * @property {string} assetTypeId UUID corresponding with the asset type\n * @property {string} createdAt ISO 8601 Extended Format date/time string\n * @property {string} description\n * @property {string} id UUID\n * @property {string} label\n * @property {string} organizationId UUID corresponding with the organization\n * @property {string} timeInterval Options are \"hourly\", \"daily\", \"weekly\", \"monthly\", \"yearly\"\n * @property {string} [units]\n * @property {string} updatedAt ISO 8601 Extended Format date/time string\n */\n\n/**\n * @typedef {Object} AssetMetricsFromServer\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 {AssetMetric[]} records\n */\n\n/**\n * @typedef {Object} AssetMetricValue\n * @property {string} assetId UUID corresponding to the asset\n * @property {string} assetMetricId UUID corresponding to the asset metric\n * @property {string} createdAt ISO 8601 Extended Format date/time string\n * @property {string} effectiveEndDate ISO 8601 Extended Format date/time string\n * @property {string} effectiveStartDate ISO 8601 Extended Format date/time string\n * @property {string} id UUID\n * @property {string} notes\n * @property {string} updatedAt ISO 8601 Extended Format date/time string\n * @property {string} value\n * @property {boolean} isEstimated Whether the value is an estimation or a true reading\n */\n\n/**\n * @typedef {Object} AssetMetricValuesFromServer\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 {AssetMetricValue[]} records\n */\n\n/**\n * @typedef {Object} AssetMetricValueCompact\n * @property {string} id the UUID corresponding to the asset metric value id\n * @property {string} value\n * @property {boolean} is_estimated\n * @property {string} effectiveEndDate ISO 8601 Extended Format date/time string\n * @property {string} effectiveStartDate ISO 8601 Extended Format date/time string\n */\n\n/**\n * @typedef {Object.<AssetMetric.label, AssetMetricValueCompact[]>} AssetMetricsKeyedByMetricId\n */\n\n/**\n * An object with asset ids as keys to another object with asset metric labels as keys.\n * At this final level the object contains arrays of {@link AssetMetricValueCompact}\n * @typedef {Object.<Asset.id, AssetMetricsKeyedByMetricId>} AssetMetricValuesByAssetIdMetricId\n * @example\n * {\n *   \"b47e45af-3e18-408a-8070-008f9e6d7b42\" : {\n *     \"facility_daily_cuft\": [\n *       {\n *         \"id\": \"cf7e45af-3e18-408a-8070-008f9e6d7b3j\",\n *         \"value\": 10,\n *         \"isEstimated\": false,\n *         \"effectiveEndDate\": \"2018-07-10T11:04:24.631Z\",\n *         \"effectiveStartDate\" \"2018-07-10T11:04:24.631Z\"\n *       }\n *     ]\n *   }\n * }\n */\n\n/**\n * Module that provides access to, and the manipulation of, information about different asset metrics\n *\n * @typicalname contxtSdk.assets.metrics\n */\nclass AssetMetrics {\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   * Creates a new asset metric\n   *\n   * API Endpoint: '/assets/types/:assetTypeId/metrics'\n   * Method: POST\n   *\n   * @param {string} assetTypeId The UUID formatted ID of the asset type\n   * @param {Object} assetMetric\n   * @param {string} assetMetric.description\n   * @param {string} assetMetric.label\n   * @param {string} assetMetric.organizationId Organization ID (UUID) to which the metric belongs\n   * @param {string} assetMetric.timeInterval Options are \"hourly\", \"daily\", \"weekly\", \"monthly\", \"yearly\"\n   * @param {string} [assetMetric.units] Units of the metric\n   *\n   * @returns {Promise}\n   * @fulfill {AssetMetric} Information about the new asset metric\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics\n   *   .create('4f0e51c6-728b-4892-9863-6d002e61204d', {\n   *     description: 'Number of injuries which occur in the facility each month',\n   *     label: 'Facility Injuries',\n   *     organizationId: 'b47e45af-3e18-408a-8070-008f9e6d7b42',\n   *     timeInterval: 'monthly',\n   *     units: 'injuries'\n   *   })\n   *   .then((assetMetric) => console.log(assetMetric))\n   *   .catch((err) => console.log(err));\n   */\n  create(assetTypeId, assetMetric = {}) {\n    if (!assetTypeId) {\n      return Promise.reject(\n        new Error('An asset type ID is required to create an asset metric.')\n      );\n    }\n\n    const hasFieldFns = {\n      default: (object, key) => !!object[key],\n      organizationId: (object, key) => has(object, key)\n    };\n    const requiredFields = [\n      'description',\n      'label',\n      'organizationId',\n      'timeInterval'\n    ];\n\n    for (let i = 0; i < requiredFields.length; i++) {\n      const field = requiredFields[i];\n      const hasField = hasFieldFns[field] || hasFieldFns.default;\n\n      if (!hasField(assetMetric, field)) {\n        return Promise.reject(\n          new Error(`A ${field} is required to create a new asset metric.`)\n        );\n      }\n    }\n\n    return this._request\n      .post(\n        `${this._baseUrl}/assets/types/${assetTypeId}/metrics`,\n        toSnakeCase(assetMetric)\n      )\n      .then((assetMetric) => toCamelCase(assetMetric));\n  }\n\n  /**\n   * Deletes an asset metric\n   *\n   * API Endpoint: '/assets/metrics/:assetMetricId'\n   * Method: DELETE\n   *\n   * @param {string} assetMetricId The UUID formatted ID of the asset metric\n   *\n   * @returns {Promise}\n   * @fulfill {undefined}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics.delete('4f0e51c6-728b-4892-9863-6d002e61204d');\n   */\n  delete(assetMetricId) {\n    if (!assetMetricId) {\n      return Promise.reject(\n        new Error(\n          'An asset metric ID is required for deleting an asset metric.'\n        )\n      );\n    }\n\n    return this._request.delete(\n      `${this._baseUrl}/assets/metrics/${assetMetricId}`\n    );\n  }\n\n  /**\n   * Gets information about an asset metric\n   *\n   * API Endpoint: '/assets/metrics/:assetMetricId'\n   * Method: GET\n   *\n   * @param {string} assetMetricId The UUID formatted ID of the asset metric\n   *\n   * @returns {Promise}\n   * @fulfill {AssetMetric} Information about the asset metric\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics\n   *   .get('4f0e51c6-728b-4892-9863-6d002e61204d')\n   *   .then((assetMetric) => console.log(assetMetric))\n   *   .catch((err) => console.log(err));\n   */\n  get(assetMetricId) {\n    if (!assetMetricId) {\n      return Promise.reject(\n        new Error(\n          'An asset metric ID is required for getting information about an asset metric.'\n        )\n      );\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/assets/metrics/${assetMetricId}`)\n      .then((assetMetric) => toCamelCase(assetMetric));\n  }\n\n  /**\n   * Gets a list of all asset metrics that belong to a given asset\n   *\n   * API Endpoint: '/assets/:assetId/metrics\n   * Method: GET\n   *\n   * @param {string} assetId The UUID formatted ID of the asset type\n   * @param {Object} [assetMetricsFilters] Specific information that is used to\n   *   filter the list of asset metrics\n   * @param {String} [assetMetricsFilters.assetMetricLabel] The label of the\n   *   associated asset metrics\n   * @param {Number} [assetMetricsFilters.limit] Maximum number of records to\n   *   return per query\n   * @param {Number} [assetMetricsFilters.offset] How many records from the first\n   *   record to start the query\n   *\n   * @returns {Promise}\n   * @fulfill {AssetMetricsFromServer}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics\n   *   .getByAssetId(\n   *     'f3be81fd-4494-443b-87a3-320b1c9aa495',\n   *      {\n   *        assetMetricLabel: 'Square Footage',\n   *        limit: 50,\n   *        offset: 150\n   *      }\n   *    )\n   *   .then((assetMetricData) => console.log(assetMetricData))\n   *   .catch((err) => console.log(err));\n   */\n  getByAssetId(assetId, assetMetricsFilters) {\n    if (!assetId) {\n      return Promise.reject(\n        new Error('An asset ID is required to get a list of all asset metrics.')\n      );\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/assets/${assetId}/metrics`, {\n        params: toSnakeCase(assetMetricsFilters)\n      })\n      .then((assetMetricsData) =>\n        formatPaginatedDataFromServer(assetMetricsData)\n      );\n  }\n\n  /**\n   * Gets a list of all asset metrics that belong to a given type\n   *\n   * API Endpoint: '/assets/types/:assetTypeId/metrics\n   * Method: GET\n   *\n   * @param {string} assetTypeId The UUID formatted ID of the asset type\n   * @param {Object} [assetMetricsFilters] Specific information that is used to\n   *   filter the list of asset metrics\n   * @param {Number} [assetMetricsFilters.limit] Maximum number of records to\n   *   return per query\n   * @param {Number} [assetMetricsFilters.offset] How many records from the first\n   *   record to start the query\n   * @param {String} [assetMetricsFilters.organizationId] The UUID formatted ID\n   *   of the organization to filter asset metrics by\n   *\n   * @returns {Promise}\n   * @fulfill {AssetMetricsFromServer}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics\n   *   .getByAssetTypeId(\n   *     '4f0e51c6-728b-4892-9863-6d002e61204d'\n   *      {\n   *        limit: 50,\n   *        offset: 150\n   *      }\n   *    )\n   *   .then((assetMetrics) => console.log(assetMetrics))\n   *   .catch((err) => console.log(err));\n   */\n  getByAssetTypeId(assetTypeId, assetMetricsFilters) {\n    if (!assetTypeId) {\n      return Promise.reject(\n        new Error(\n          'An asset type ID is required to get a list of all asset metrics.'\n        )\n      );\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/assets/types/${assetTypeId}/metrics`, {\n        params: toSnakeCase(assetMetricsFilters)\n      })\n      .then((assetMetricsData) =>\n        formatPaginatedDataFromServer(assetMetricsData)\n      );\n  }\n\n  /**\n   * Updates an asset metric's data\n   *\n   * API Endpoint: '/assets/metrics/:assetMetricId'\n   * Method: PUT\n   *\n   * @param {string} assetMetricId The ID of the asset metric to update (formatted as a UUID)\n   * @param {Object} update An object containing the updated data for the asset metric\n   * @param {string} [update.description]\n   * @param {string} [update.label]\n   * @param {string} [update.timeInterval]\n   * @param {string} [update.units]\n   *\n   * @returns {Promise}\n   * @fulfill {undefined}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics\n   *   .update('5f310899-d8f9-4dac-ae82-cedb2048a8ef', {\n   *     description: 'An updated description of this metric'\n   *   });\n   */\n  update(assetMetricId, update) {\n    if (!assetMetricId) {\n      return Promise.reject(\n        new Error('An asset metric ID is required to update an asset metric.')\n      );\n    }\n\n    if (!update) {\n      return Promise.reject(\n        new Error('An update is required to update an asset metric.')\n      );\n    }\n\n    if (!isPlainObject(update)) {\n      return Promise.reject(\n        new Error(\n          'The asset metric 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: ['createdAt', 'id', 'label', 'organizationId', 'updatedAt']\n    });\n\n    return this._request.put(\n      `${this._baseUrl}/assets/metrics/${assetMetricId}`,\n      formattedUpdate\n    );\n  }\n\n  /**\n   * Creates a new asset metric value\n   *\n   * API Endpoint: '/assets/:assetId/metrics/:assetMetricId/values'\n   * Method: POST\n   *\n   * @param {string} assetId The ID of the asset (formatted as a UUID)\n   * @param {Object} assetMetricValue\n   * @param {string} assetMetricValue.assetMetricId UUID corresponding to the asset metric\n   * @param {string} assetMetricValue.effectiveEndDate ISO 8601 Extended Format date/time string\n   * @param {string} assetMetricValue.effectiveStartDate ISO 8601 Extended Format date/time string\n   * @param {string} [assetMetricValue.notes]\n   * @param {string} assetMetricValue.value\n   * @param {boolean} [assetMetricValue.isEstimated] Whether the value is an estimation or a true reading\n   *\n   * @returns {Promise}\n   * @fulfill {AssetMetricValue}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics\n   *   .createValue('1140cc2e-6d13-42ee-9941-487fe98f8e2d', {\n   *      assetMetricId: 'cca11baa-cf7d-44c0-9d0a-6ad73d5f30cb',\n   *      effectiveEndDate: '2018-08-28T18:18:18.264Z',\n   *      effectiveStartDate: '2018-08-27T18:18:03.175Z',\n   *      notes: 'Iure delectus non sunt a voluptates pariatur fuga.',\n   *      value: '2000',\n   *      isEstimated: true\n   *    })\n   *    .then((newAssetMetricValue) => {\n   *      console.log(newAssetMetricValue);\n   *    })\n   *    .catch((error) => {\n   *      console.error(error);\n   *    });\n   */\n  createValue(assetId, assetMetricValue = {}) {\n    const requiredFields = [\n      'assetMetricId',\n      'effectiveEndDate',\n      'effectiveStartDate',\n      'value'\n    ];\n\n    if (!assetId) {\n      return Promise.reject(\n        new Error('An asset ID is required to create a new asset metric value.')\n      );\n    }\n\n    for (let i = 0; i < requiredFields.length; i++) {\n      const field = requiredFields[i];\n\n      if (!assetMetricValue[field]) {\n        return Promise.reject(\n          new Error(\n            `A ${field} is required to create a new asset metric value.`\n          )\n        );\n      }\n    }\n\n    return this._request\n      .post(\n        `${this._baseUrl}/assets/${assetId}/metrics/${\n          assetMetricValue.assetMetricId\n        }/values`,\n        toSnakeCase(assetMetricValue)\n      )\n      .then((assetMetricValue) => toCamelCase(assetMetricValue));\n  }\n\n  /**\n   * Deletes an asset metric value\n   *\n   * API Endpoint: '/assets/metrics/values/:assetMetricValueId'\n   * Method: DELETE\n   *\n   * @param {string} assetMetricValueId The ID of the asset metric value (formatted as a UUID)\n   *\n   * @returns {Promise}\n   * @fulfill {undefined}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics.deleteValue(\n   *   'f4cd0d84-6c61-4d19-9322-7c1ab226dc83'\n   * );\n   */\n  deleteValue(assetMetricValueId) {\n    if (!assetMetricValueId) {\n      return Promise.reject(\n        new Error(\n          'An asset metric value ID is required for deleting an asset metric value.'\n        )\n      );\n    }\n\n    return this._request.delete(\n      `${this._baseUrl}/assets/metrics/values/${assetMetricValueId}`\n    );\n  }\n\n  /**\n   * Gets asset metric values for a particular asset\n   *\n   * API Endpoint: '/assets/:assetId/metrics/values'\n   * Method: GET\n   *\n   * @param {String} assetId The ID of the asset (formatted as a UUID)\n   * @param {Object} [assetMetricValuesFilters] Specific information that is\n   *   used to filter the list of asset metric values\n   * @param {String} [assetMetricValuesFilters.assetMetricLabel] The label of\n   *   the associated asset metrics\n   * @param {String} [assetMetricValuesFilters.effectiveEndDate] Effective end\n   *   date (ISO 8601 Extended formatted) of the asset metric values\n   * @param {String} [assetMetricValuesFilters.effectiveStartDate] Effective\n   *   start date (ISO 8601 Extended formatted) of the asset metric values\n   * @param {Number} [assetMetricValuesFilters.limit] Maximum number of records\n   *   to return per query\n   * @param {Number} [assetMetricValuesFilters.offset] How many records from the\n   *   first record to start the query\n   *\n   * @returns {Promise}\n   * @fulfill {AssetMetricValuesFromServer}\n   * @rejects {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics\n   *   .getValuesByAssetId(\n   *      'f9c606f3-d270-4623-bf3b-b085424d9a8b',\n   *      {\n   *        assetMetricLabel: 'Square Footage',\n   *        effectiveEndDate: '2018-04-13T15:44:51.943Z'\n   *        effectiveStartDate: '2017-12-13T15:42:01.376Z'\n   *        limit: 10,\n   *        offset: 200\n   *      }\n   *    )\n   *   .then((assetMetricValuesData) => console.log(assetMetricValuesData))\n   *   .catch((err) => console.log(err));\n   */\n  getValuesByAssetId(assetId, assetMetricValuesFilters) {\n    if (!assetId) {\n      return Promise.reject(\n        new Error(\n          'An asset ID is required to get a list of asset metric values.'\n        )\n      );\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/assets/${assetId}/metrics/values`, {\n        params: toSnakeCase(assetMetricValuesFilters)\n      })\n      .then((assetMetricValueData) =>\n        formatPaginatedDataFromServer(assetMetricValueData)\n      );\n  }\n\n  /**\n   * Gets asset metric values for a particular asset and metric\n   *\n   * API Endpoint: '/assets/:assetId/metrics/:assetMetricId/values'\n   * Method: GET\n   *\n   * @param {String} assetId The ID of the asset (formatted as a UUID)\n   * @param {String} assetMetricId The ID of the asset metric (formatted as a\n   *   UUID)\n   * @param {Object} [assetMetricValuesFilters] Specific information that is\n   *   used to filter the list of asset metric values\n   * @param {String} [assetMetricValuesFilters.effectiveEndDate] Effective end\n   *   date (ISO 8601 Extended formatted) of the asset metric values\n   * @param {String} [assetMetricValuesFilters.effectiveStartDate] Effective\n   *   start date (ISO 8601 Extended formatted) of the asset metric values\n   * @param {Number} [assetMetricValuesFilters.limit] Maximum number of records\n   *   to return per query\n   * @param {Number} [assetMetricValuesFilters.offset] How many records from the\n   *   first record to start the query\n   *\n   * @returns {Promise}\n   * @fulfill {AssetMetricValuesFromServer}\n   * @rejects {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics\n   *   .getValuesByMetricId(\n   *      'd7329ef3-ca63-4ad5-bb3e-632b702584f8',\n   *      'a1329ef3-ca63-4ad5-bb3e-632b702584f8',\n   *      {\n   *        limit: 10,\n   *        effectiveStartDate: '2018-07-11T19:14:49.715Z'\n   *      }\n   *    )\n   *   .then((assetMetricValuesData) => {\n   *     console.log(assetMetricValuesData);\n   *   })\n   *   .catch((err) => console.log(err));\n   */\n  getValuesByMetricId(assetId, assetMetricId, assetMetricValuesFilters) {\n    if (!assetId) {\n      return Promise.reject(\n        new Error(\n          'An asset ID is required to get a list of asset metric values.'\n        )\n      );\n    }\n\n    if (!assetMetricId) {\n      return Promise.reject(\n        new Error(\n          'An asset metric ID is required to get a list of asset metric values.'\n        )\n      );\n    }\n\n    return this._request\n      .get(\n        `${this._baseUrl}/assets/${assetId}/metrics/${assetMetricId}/values`,\n        {\n          params: toSnakeCase(assetMetricValuesFilters)\n        }\n      )\n      .then((assetMetricValueData) =>\n        formatPaginatedDataFromServer(assetMetricValueData)\n      );\n  }\n\n  /**\n   * Gets asset metric values for a particular asset and metric\n   *\n   * API Endpoint: '/assets/metrics/values'\n   * Method: GET\n   *\n   * @param {Object} [assetMetricFilters] Specific information that is\n   *   used to filter the list of asset metric values\n   * @param {String[]} assetMetricFilters.assetIds an array of asset ids\n   *   to request the metrics for\n   * @param {String[]} assetMetricFilters.labels an array of metric labels\n   *   to request the metrics for\n   * @param {String} [assetMetricFilters.effectiveEndDate] Effective end\n   *   date (ISO 8601 Extended formatted) of the asset metric values\n   * @param {String} [assetMetricFilters.effectiveStartDate] Effective\n   *   start date (ISO 8601 Extended formatted) of the asset metric values\n   * @returns {Promise}\n   * @fulfill {AssetMetricValuesByAssetIdMetricId}\n   * @rejects {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics\n   *   .getValuesByMetricIdsAssetIds(\n   *      {\n   *        effectiveStartDate: '2018-07-11T19:14:49.715Z',\n   *        effectiveEndDate: '2018-07-11T19:14:49.715Z',\n   *        assetIds: ['2140cc2e-6d13-42ee-9941-487fe98f8e2d', '5540cc2e-6d13-42ee-9941-487fe98f8efc'],\n   *        labels: ['facility_kwh', 'facility_cuft'],\n   *      }\n   *    )\n   *   .then((assetMetricValuesByAssetIdMetricId) => {\n   *     console.log(assetMetricValuesByAssetIdMetricId);\n   *   })\n   *   .catch((err) => console.log(err));\n   */\n  getValuesByMetricIdsAssetIds(assetMetricFilters) {\n    const requiredFields = ['assetIds', 'labels'];\n\n    for (let i = 0; i < requiredFields.length; i++) {\n      const field = requiredFields[i];\n\n      if (!assetMetricFilters[field]) {\n        return Promise.reject(\n          new Error(`The ${field} param is required to fetch data.`)\n        );\n      }\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/assets/metrics/values`, {\n        params: toSnakeCase(assetMetricFilters),\n        paramsSerializer: stringifyParamsWithCommaSeparatedArrays\n      })\n      .then((assetMetricValues) => {\n        const result = toCamelCase(assetMetricValues, {\n          excludeTransform: [\n            ...assetMetricFilters.labels,\n            ...assetMetricFilters.assetIds\n          ]\n        });\n\n        return result;\n      });\n  }\n\n  /**\n   * Updates an asset metric value\n   *\n   * API Endpoint: '/assets/metrics/values/:assetMetricValueId'\n   * Method: PUT\n   *\n   * @param {string} assetMetricValueId The ID of the asset metric value to update (formatted as a UUID)\n   * @param {Object} update An object containing the updated data for the asset metric value\n   * @param {string} [update.effectiveEndDate] ISO 8601 Extended Format date/time string\n   * @param {string} [update.effectiveStartDate] ISO 8601 Extended Format date/time string\n   * @param {string} [update.notes]\n   * @param {string} [update.value]\n   * @param {boolean} [update.isEstimated] Whether the value is an estimation or a true reading\n   *\n   * @returns {Promise}\n   * @fulfill {undefined}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.metrics\n   *   .updateValue('2140cc2e-6d13-42ee-9941-487fe98f8e2d', {\n   *     effectiveEndDate: '2018-07-10T11:04:24.631Z',\n   *     notes: 'Dolores et sapiente sunt doloribus aut in.',\n   *     value: '61456',\n   *     isEstimated: true\n   *   })\n   *   .catch((err) => console.log(err));\n   */\n  updateValue(assetMetricValueId, update) {\n    if (!assetMetricValueId) {\n      return Promise.reject(\n        new Error(\n          'An asset metric value ID is required to update an asset metric value.'\n        )\n      );\n    }\n\n    if (!update) {\n      return Promise.reject(\n        new Error('An update is required to update an asset metric value.')\n      );\n    }\n\n    if (!isPlainObject(update)) {\n      return Promise.reject(\n        new Error(\n          'The asset metric value 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: ['assetId', 'assetMetricId', 'id']\n    });\n\n    return this._request.put(\n      `${this._baseUrl}/assets/metrics/values/${assetMetricValueId}`,\n      formattedUpdate\n    );\n  }\n}\n\nexport default AssetMetrics;\n"]}

package/lib/assets/assetTypes.js

@@ -1,287 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-
-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; }; }();
-
-var _lodash = require('lodash.has');
-
-var _lodash2 = _interopRequireDefault(_lodash);
-
-var _lodash3 = require('lodash.isplainobject');
-
-var _lodash4 = _interopRequireDefault(_lodash3);
-
-var _objects = require('../utils/objects');
-
-var _pagination = require('../utils/pagination');
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-/**
- * @typedef {Object} AssetType
- * @property {string} createdAt ISO 8601 Extended Format date/time string
- * @property {string} description
- * @property {string} id UUID
- * @property {string} label
- * @property {string} organizationId UUID corresponding with the organization
- * @property {string} updatedAt ISO 8601 Extended Format date/time string
- */
-
-/**
- * @typedef {Object} AssetTypesFromServer
- * @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 {AssetType[]} records
- */
-
-/**
- * Module that provides access to, and the manipulation of, information about different asset types
- *
- * @typicalname contxtSdk.assets.types
- */
-var AssetTypes = 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} baseUrl The base URL provided by the parent module
-   */
-  function AssetTypes(sdk, request, baseUrl) {
-    _classCallCheck(this, AssetTypes);
-
-    this._baseUrl = baseUrl;
-    this._request = request;
-    this._sdk = sdk;
-  }
-
-  /**
-   * Creates a new asset type
-   *
-   * API Endpoint: '/assets/types'
-   * Method: POST
-   *
-   * @param {Object} assetType
-   * @param {string} assetType.description
-   * @param {string} assetType.label
-   * @param {string} assetType.organizationId The ID of the asset type's parent organization. Can be
-   *   explicitly set to `null` to create a global asset type
-   *
-   * @returns {Promise}
-   * @fulfill {AssetType} Information about the new asset type
-   * @reject {Error}
-   *
-   * @example
-   * contxtSdk.assets.types
-   *   .create({
-   *     description: 'A physicial facility building',
-   *     label: 'Facility',
-   *     organizationId: 'b47e45af-3e18-408a-8070-008f9e6d7b42'
-   *   })
-   *   .then((assetType) => console.log(assetType))
-   *   .catch((err) => console.log(err));
-   */
-
-
-  _createClass(AssetTypes, [{
-    key: 'create',
-    value: function create() {
-      var assetType = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
-      var hasFieldFns = {
-        default: function _default(object, key) {
-          return !!object[key];
-        },
-        organizationId: function organizationId(object, key) {
-          return (0, _lodash2.default)(object, key);
-        }
-      };
-      var requiredFields = ['description', 'label', 'organizationId'];
-
-      for (var i = 0; i < requiredFields.length; i++) {
-        var field = requiredFields[i];
-        var hasField = hasFieldFns[field] || hasFieldFns.default;
-
-        if (!hasField(assetType, field)) {
-          return Promise.reject(new Error('A ' + field + ' is required to create a new asset type.'));
-        }
-      }
-
-      return this._request.post(this._baseUrl + '/assets/types', (0, _objects.toSnakeCase)(assetType)).then(function (assetType) {
-        return (0, _objects.toCamelCase)(assetType);
-      });
-    }
-
-    /**
-     * Deletes an asset type
-     *
-     * API Endpoint: '/assets/types/:assetTypeId'
-     * Method: DELETE
-     *
-     * @param {string} assetTypeId The ID of the asset type (formatted as a UUID)
-     *
-     * @returns {Promise}
-     * @fulfill {undefined}
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.assets.types.delete('4f0e51c6-728b-4892-9863-6d002e61204d')
-     */
-
-  }, {
-    key: 'delete',
-    value: function _delete(assetTypeId) {
-      if (!assetTypeId) {
-        return Promise.reject(new Error('An asset type ID is required for deleting an asset type.'));
-      }
-
-      return this._request.delete(this._baseUrl + '/assets/types/' + assetTypeId);
-    }
-
-    /**
-     * Gets information about an asset type
-     *
-     * API Endpoint: '/assets/types/:assetTypeId'
-     * Method: GET
-     *
-     * @param {string} assetTypeId The ID of the asset type (formatted as a UUID)
-     *
-     * @returns {Promise}
-     * @fulfill {AssetType} Information about the asset type
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.assets.types
-     *   .get('4f0e51c6-728b-4892-9863-6d002e61204d')
-     *   .then((assetType) => console.log(assetType))
-     *   .catch((err) => console.log(err));
-     */
-
-  }, {
-    key: 'get',
-    value: function get(assetTypeId) {
-      if (!assetTypeId) {
-        return Promise.reject(new Error('An asset type ID is required for getting information about an asset type.'));
-      }
-
-      return this._request.get(this._baseUrl + '/assets/types/' + assetTypeId).then(function (assetType) {
-        return (0, _objects.toCamelCase)(assetType);
-      });
-    }
-
-    /**
-     * Gets a list of all asset types
-     *
-     * API Endpoint: '/assets/types/
-     * Method: GET
-     *
-     * @param {PaginationOptions} [paginationOptions]
-     *
-     * @returns {Promise}
-     * @fulfill {AssetTypesFromServer}
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.assets.types
-     *   .getAll()
-     *   .then((assetTypes) => console.log(assetTypes))
-     *   .catch((err) => console.log(err));
-     */
-
-  }, {
-    key: 'getAll',
-    value: function getAll(paginationOptions) {
-      return this._request.get(this._baseUrl + '/assets/types', {
-        params: (0, _objects.toSnakeCase)(paginationOptions)
-      }).then(function (assetTypesData) {
-        return (0, _pagination.formatPaginatedDataFromServer)(assetTypesData);
-      });
-    }
-
-    /**
-     * Gets a list of all asset types that belong to a particular organization
-     *
-     * API Endpoint: '/organizations/:organizationId/assets/types'
-     * Method: GET
-     *
-     * @param {string} organizationId UUID corresponding with an organization
-     * @param {PaginationOptions} [paginationOptions]
-     *
-     * @returns {Promise}
-     * @fulfill {AssetTypesFromServer}
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.assets.types
-     *   .getAllByOrganizationId('53fba880-70b7-47a2-b4e3-ad9ecfb67d5c')
-     *   .then((assetTypes) => console.log(assetTypes))
-     *   .catch((err) => console.log(assetTypes));
-     */
-
-  }, {
-    key: 'getAllByOrganizationId',
-    value: function getAllByOrganizationId(organizationId, paginationOptions) {
-      if (!organizationId) {
-        return Promise.reject(new Error("An organization ID is required for getting a list of an organization's asset types."));
-      }
-
-      return this._request.get(this._baseUrl + '/organizations/' + organizationId + '/assets/types', {
-        params: (0, _objects.toSnakeCase)(paginationOptions)
-      }).then(function (assetTypesData) {
-        return (0, _pagination.formatPaginatedDataFromServer)(assetTypesData);
-      });
-    }
-
-    /**
-     * Updates an asset type's data
-     *
-     * API Endpoint: '/assets/types/:assetTypeId'
-     * Method: PUT
-     *
-     * @param {string} assetTypeId The ID of the asset type to update (formatted as a UUID)
-     * @param {Object} update An object containing the updated data for the asset type
-     * @param {string} update.description
-     *
-     * @returns {Promise}
-     * @fulfill {undefined}
-     * @reject {Error}
-     *
-     * @example
-     * contxtSdk.assets.types
-     *   .update('5f310899-d8f9-4dac-ae82-cedb2048a8ef', {
-     *     description: 'A physical facility building'
-     *   });
-     */
-
-  }, {
-    key: 'update',
-    value: function update(assetTypeId, _update) {
-      if (!assetTypeId) {
-        return Promise.reject(new Error('An asset type ID is required to update an asset type.'));
-      }
-
-      if (!_update) {
-        return Promise.reject(new Error('An update is required to update an asset type.'));
-      }
-
-      if (!(0, _lodash4.default)(_update)) {
-        return Promise.reject(new Error('The asset type update must be a well-formed object with the data you wish to update.'));
-      }
-
-      var formattedUpdate = (0, _objects.toSnakeCase)(_update, {
-        excludeKeys: ['id', 'label', 'organizationId']
-      });
-
-      return this._request.put(this._baseUrl + '/assets/types/' + assetTypeId, formattedUpdate);
-    }
-  }]);
-
-  return AssetTypes;
-}();
-
-exports.default = AssetTypes;
-//# sourceMappingURL=assetTypes.js.map

package/lib/assets/assetTypes.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["assets/assetTypes.js"],"names":["AssetTypes","sdk","request","baseUrl","_baseUrl","_request","_sdk","assetType","hasFieldFns","default","object","key","organizationId","requiredFields","i","length","field","hasField","Promise","reject","Error","post","then","assetTypeId","delete","get","paginationOptions","params","assetTypesData","update","formattedUpdate","excludeKeys","put"],"mappings":";;;;;;;;AAAA;;;;AACA;;;;AACA;;AACA;;;;;;AAEA;;;;;;;;;;AAUA;;;;;;;;AAQA;;;;;IAKMA,U;AACJ;;;;;AAKA,sBAAYC,GAAZ,EAAiBC,OAAjB,EAA0BC,OAA1B,EAAmC;AAAA;;AACjC,SAAKC,QAAL,GAAgBD,OAAhB;AACA,SAAKE,QAAL,GAAgBH,OAAhB;AACA,SAAKI,IAAL,GAAYL,GAAZ;AACD;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6BA0BuB;AAAA,UAAhBM,SAAgB,uEAAJ,EAAI;;AACrB,UAAMC,cAAc;AAClBC,iBAAS,kBAACC,MAAD,EAASC,GAAT;AAAA,iBAAiB,CAAC,CAACD,OAAOC,GAAP,CAAnB;AAAA,SADS;AAElBC,wBAAgB,wBAACF,MAAD,EAASC,GAAT;AAAA,iBAAiB,sBAAID,MAAJ,EAAYC,GAAZ,CAAjB;AAAA;AAFE,OAApB;AAIA,UAAME,iBAAiB,CAAC,aAAD,EAAgB,OAAhB,EAAyB,gBAAzB,CAAvB;;AAEA,WAAK,IAAIC,IAAI,CAAb,EAAgBA,IAAID,eAAeE,MAAnC,EAA2CD,GAA3C,EAAgD;AAC9C,YAAME,QAAQH,eAAeC,CAAf,CAAd;AACA,YAAMG,WAAWT,YAAYQ,KAAZ,KAAsBR,YAAYC,OAAnD;;AAEA,YAAI,CAACQ,SAASV,SAAT,EAAoBS,KAApB,CAAL,EAAiC;AAC/B,iBAAOE,QAAQC,MAAR,CACL,IAAIC,KAAJ,QAAeJ,KAAf,8CADK,CAAP;AAGD;AACF;;AAED,aAAO,KAAKX,QAAL,CACJgB,IADI,CACI,KAAKjB,QADT,oBACkC,0BAAYG,SAAZ,CADlC,EAEJe,IAFI,CAEC,UAACf,SAAD;AAAA,eAAe,0BAAYA,SAAZ,CAAf;AAAA,OAFD,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;4BAeOgB,W,EAAa;AAClB,UAAI,CAACA,WAAL,EAAkB;AAChB,eAAOL,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,0DAAV,CADK,CAAP;AAGD;;AAED,aAAO,KAAKf,QAAL,CAAcmB,MAAd,CAAwB,KAAKpB,QAA7B,sBAAsDmB,WAAtD,CAAP;AACD;;AAED;;;;;;;;;;;;;;;;;;;;;wBAkBIA,W,EAAa;AACf,UAAI,CAACA,WAAL,EAAkB;AAChB,eAAOL,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,2EADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKf,QAAL,CACJoB,GADI,CACG,KAAKrB,QADR,sBACiCmB,WADjC,EAEJD,IAFI,CAEC,UAACf,SAAD;AAAA,eAAe,0BAAYA,SAAZ,CAAf;AAAA,OAFD,CAAP;AAGD;;AAED;;;;;;;;;;;;;;;;;;;;;2BAkBOmB,iB,EAAmB;AACxB,aAAO,KAAKrB,QAAL,CACJoB,GADI,CACG,KAAKrB,QADR,oBACiC;AACpCuB,gBAAQ,0BAAYD,iBAAZ;AAD4B,OADjC,EAIJJ,IAJI,CAIC,UAACM,cAAD;AAAA,eAAoB,+CAA8BA,cAA9B,CAApB;AAAA,OAJD,CAAP;AAKD;;AAED;;;;;;;;;;;;;;;;;;;;;;2CAmBuBhB,c,EAAgBc,iB,EAAmB;AACxD,UAAI,CAACd,cAAL,EAAqB;AACnB,eAAOM,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,qFADF,CADK,CAAP;AAKD;;AAED,aAAO,KAAKf,QAAL,CACJoB,GADI,CACG,KAAKrB,QADR,uBACkCQ,cADlC,oBACiE;AACpEe,gBAAQ,0BAAYD,iBAAZ;AAD4D,OADjE,EAIJJ,IAJI,CAIC,UAACM,cAAD;AAAA,eAAoB,+CAA8BA,cAA9B,CAApB;AAAA,OAJD,CAAP;AAKD;;AAED;;;;;;;;;;;;;;;;;;;;;;;2BAoBOL,W,EAAaM,O,EAAQ;AAC1B,UAAI,CAACN,WAAL,EAAkB;AAChB,eAAOL,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,uDAAV,CADK,CAAP;AAGD;;AAED,UAAI,CAACS,OAAL,EAAa;AACX,eAAOX,QAAQC,MAAR,CACL,IAAIC,KAAJ,CAAU,gDAAV,CADK,CAAP;AAGD;;AAED,UAAI,CAAC,sBAAcS,OAAd,CAAL,EAA4B;AAC1B,eAAOX,QAAQC,MAAR,CACL,IAAIC,KAAJ,CACE,sFADF,CADK,CAAP;AAKD;;AAED,UAAMU,kBAAkB,0BAAYD,OAAZ,EAAoB;AAC1CE,qBAAa,CAAC,IAAD,EAAO,OAAP,EAAgB,gBAAhB;AAD6B,OAApB,CAAxB;;AAIA,aAAO,KAAK1B,QAAL,CAAc2B,GAAd,CACF,KAAK5B,QADH,sBAC4BmB,WAD5B,EAELO,eAFK,CAAP;AAID;;;;;;kBAGY9B,U","file":"assetTypes.js","sourcesContent":["import has from 'lodash.has';\nimport isPlainObject from 'lodash.isplainobject';\nimport { toCamelCase, toSnakeCase } from '../utils/objects';\nimport { formatPaginatedDataFromServer } from '../utils/pagination';\n\n/**\n * @typedef {Object} AssetType\n * @property {string} createdAt ISO 8601 Extended Format date/time string\n * @property {string} description\n * @property {string} id UUID\n * @property {string} label\n * @property {string} organizationId UUID corresponding with the organization\n * @property {string} updatedAt ISO 8601 Extended Format date/time string\n */\n\n/**\n * @typedef {Object} AssetTypesFromServer\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 {AssetType[]} records\n */\n\n/**\n * Module that provides access to, and the manipulation of, information about different asset types\n *\n * @typicalname contxtSdk.assets.types\n */\nclass AssetTypes {\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   * Creates a new asset type\n   *\n   * API Endpoint: '/assets/types'\n   * Method: POST\n   *\n   * @param {Object} assetType\n   * @param {string} assetType.description\n   * @param {string} assetType.label\n   * @param {string} assetType.organizationId The ID of the asset type's parent organization. Can be\n   *   explicitly set to `null` to create a global asset type\n   *\n   * @returns {Promise}\n   * @fulfill {AssetType} Information about the new asset type\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.types\n   *   .create({\n   *     description: 'A physicial facility building',\n   *     label: 'Facility',\n   *     organizationId: 'b47e45af-3e18-408a-8070-008f9e6d7b42'\n   *   })\n   *   .then((assetType) => console.log(assetType))\n   *   .catch((err) => console.log(err));\n   */\n  create(assetType = {}) {\n    const hasFieldFns = {\n      default: (object, key) => !!object[key],\n      organizationId: (object, key) => has(object, key)\n    };\n    const requiredFields = ['description', 'label', 'organizationId'];\n\n    for (let i = 0; i < requiredFields.length; i++) {\n      const field = requiredFields[i];\n      const hasField = hasFieldFns[field] || hasFieldFns.default;\n\n      if (!hasField(assetType, field)) {\n        return Promise.reject(\n          new Error(`A ${field} is required to create a new asset type.`)\n        );\n      }\n    }\n\n    return this._request\n      .post(`${this._baseUrl}/assets/types`, toSnakeCase(assetType))\n      .then((assetType) => toCamelCase(assetType));\n  }\n\n  /**\n   * Deletes an asset type\n   *\n   * API Endpoint: '/assets/types/:assetTypeId'\n   * Method: DELETE\n   *\n   * @param {string} assetTypeId The ID of the asset type (formatted as a UUID)\n   *\n   * @returns {Promise}\n   * @fulfill {undefined}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.types.delete('4f0e51c6-728b-4892-9863-6d002e61204d')\n   */\n  delete(assetTypeId) {\n    if (!assetTypeId) {\n      return Promise.reject(\n        new Error('An asset type ID is required for deleting an asset type.')\n      );\n    }\n\n    return this._request.delete(`${this._baseUrl}/assets/types/${assetTypeId}`);\n  }\n\n  /**\n   * Gets information about an asset type\n   *\n   * API Endpoint: '/assets/types/:assetTypeId'\n   * Method: GET\n   *\n   * @param {string} assetTypeId The ID of the asset type (formatted as a UUID)\n   *\n   * @returns {Promise}\n   * @fulfill {AssetType} Information about the asset type\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.types\n   *   .get('4f0e51c6-728b-4892-9863-6d002e61204d')\n   *   .then((assetType) => console.log(assetType))\n   *   .catch((err) => console.log(err));\n   */\n  get(assetTypeId) {\n    if (!assetTypeId) {\n      return Promise.reject(\n        new Error(\n          'An asset type ID is required for getting information about an asset type.'\n        )\n      );\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/assets/types/${assetTypeId}`)\n      .then((assetType) => toCamelCase(assetType));\n  }\n\n  /**\n   * Gets a list of all asset types\n   *\n   * API Endpoint: '/assets/types/\n   * Method: GET\n   *\n   * @param {PaginationOptions} [paginationOptions]\n   *\n   * @returns {Promise}\n   * @fulfill {AssetTypesFromServer}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.types\n   *   .getAll()\n   *   .then((assetTypes) => console.log(assetTypes))\n   *   .catch((err) => console.log(err));\n   */\n  getAll(paginationOptions) {\n    return this._request\n      .get(`${this._baseUrl}/assets/types`, {\n        params: toSnakeCase(paginationOptions)\n      })\n      .then((assetTypesData) => formatPaginatedDataFromServer(assetTypesData));\n  }\n\n  /**\n   * Gets a list of all asset types that belong to a particular organization\n   *\n   * API Endpoint: '/organizations/:organizationId/assets/types'\n   * Method: GET\n   *\n   * @param {string} organizationId UUID corresponding with an organization\n   * @param {PaginationOptions} [paginationOptions]\n   *\n   * @returns {Promise}\n   * @fulfill {AssetTypesFromServer}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.types\n   *   .getAllByOrganizationId('53fba880-70b7-47a2-b4e3-ad9ecfb67d5c')\n   *   .then((assetTypes) => console.log(assetTypes))\n   *   .catch((err) => console.log(assetTypes));\n   */\n  getAllByOrganizationId(organizationId, paginationOptions) {\n    if (!organizationId) {\n      return Promise.reject(\n        new Error(\n          \"An organization ID is required for getting a list of an organization's asset types.\"\n        )\n      );\n    }\n\n    return this._request\n      .get(`${this._baseUrl}/organizations/${organizationId}/assets/types`, {\n        params: toSnakeCase(paginationOptions)\n      })\n      .then((assetTypesData) => formatPaginatedDataFromServer(assetTypesData));\n  }\n\n  /**\n   * Updates an asset type's data\n   *\n   * API Endpoint: '/assets/types/:assetTypeId'\n   * Method: PUT\n   *\n   * @param {string} assetTypeId The ID of the asset type to update (formatted as a UUID)\n   * @param {Object} update An object containing the updated data for the asset type\n   * @param {string} update.description\n   *\n   * @returns {Promise}\n   * @fulfill {undefined}\n   * @reject {Error}\n   *\n   * @example\n   * contxtSdk.assets.types\n   *   .update('5f310899-d8f9-4dac-ae82-cedb2048a8ef', {\n   *     description: 'A physical facility building'\n   *   });\n   */\n  update(assetTypeId, update) {\n    if (!assetTypeId) {\n      return Promise.reject(\n        new Error('An asset type ID is required to update an asset type.')\n      );\n    }\n\n    if (!update) {\n      return Promise.reject(\n        new Error('An update is required to update an asset type.')\n      );\n    }\n\n    if (!isPlainObject(update)) {\n      return Promise.reject(\n        new Error(\n          'The asset type 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', 'label', 'organizationId']\n    });\n\n    return this._request.put(\n      `${this._baseUrl}/assets/types/${assetTypeId}`,\n      formattedUpdate\n    );\n  }\n}\n\nexport default AssetTypes;\n"]}