@ndustrial/contxt-sdk 4.3.4 → 5.1.0

package/src/assets/assetMetrics.spec.js

@@ -1,1180 +0,0 @@
-import omit from 'lodash.omit';
-import AssetMetrics from './assetMetrics';
-import * as objectUtils from '../utils/objects';
-import * as paginationUtils from '../utils/pagination';
-import * as urlUtils from '../utils/url';
-
-describe('Assets/Metrics', function() {
-  let baseRequest;
-  let baseSdk;
-  let expectedHost;
-
-  beforeEach(function() {
-    baseRequest = {
-      delete: sinon.stub().resolves(),
-      get: sinon.stub().resolves(),
-      post: sinon.stub().resolves(),
-      put: sinon.stub().resolves()
-    };
-    baseSdk = {
-      config: {
-        audiences: {
-          facilities: fixture.build('audience')
-        }
-      }
-    };
-    expectedHost = faker.internet.url();
-  });
-
-  afterEach(function() {
-    sinon.restore();
-  });
-
-  describe('constructor', function() {
-    let assetMetrics;
-
-    beforeEach(function() {
-      assetMetrics = new AssetMetrics(baseSdk, baseRequest, expectedHost);
-    });
-
-    it('sets a base url for the class instance', function() {
-      expect(assetMetrics._baseUrl).to.equal(expectedHost);
-    });
-
-    it('appends the supplied request module to the class instance', function() {
-      expect(assetMetrics._request).to.deep.equal(baseRequest);
-    });
-
-    it('appends the supplied sdk to the class instance', function() {
-      expect(assetMetrics._sdk).to.deep.equal(baseSdk);
-    });
-  });
-
-  describe('create', function() {
-    context('when all required information is supplied', function() {
-      let assetMetricFromServerAfterFormat;
-      let assetMetricFromServerBeforeFormat;
-      let assetMetricToServerAfterFormat;
-      let assetMetricToServerBeforeFormat;
-      let assetTypeId;
-      let promise;
-      let request;
-      let toCamelCase;
-      let toSnakeCase;
-
-      beforeEach(function() {
-        assetMetricFromServerAfterFormat = fixture.build('assetMetric');
-        assetMetricFromServerBeforeFormat = fixture.build('assetMetric', null, {
-          fromServer: true
-        });
-        assetMetricToServerAfterFormat = fixture.build('assetMetric', null, {
-          fromServer: true
-        });
-        assetMetricToServerBeforeFormat = fixture.build('assetMetric');
-
-        assetTypeId = fixture.build('assetType').id;
-
-        request = {
-          ...baseRequest,
-          post: sinon.stub().resolves(assetMetricFromServerBeforeFormat)
-        };
-        toCamelCase = sinon
-          .stub(objectUtils, 'toCamelCase')
-          .returns(assetMetricFromServerAfterFormat);
-        toSnakeCase = sinon
-          .stub(objectUtils, 'toSnakeCase')
-          .returns(assetMetricToServerAfterFormat);
-
-        const assetMetrics = new AssetMetrics(baseSdk, request, expectedHost);
-
-        promise = assetMetrics.create(
-          assetTypeId,
-          assetMetricToServerBeforeFormat
-        );
-      });
-
-      it('formats the submitted asset metric object to send to the server', function() {
-        expect(toSnakeCase).to.be.deep.calledWith(
-          assetMetricToServerBeforeFormat
-        );
-      });
-
-      it('creates a new asset metric', function() {
-        expect(request.post).to.be.deep.calledWith(
-          `${expectedHost}/assets/types/${assetTypeId}/metrics`,
-          assetMetricToServerAfterFormat
-        );
-      });
-
-      it('formats the returned asset metric object', function() {
-        return promise.then(() => {
-          expect(toCamelCase).to.be.deep.calledWith(
-            assetMetricFromServerBeforeFormat
-          );
-        });
-      });
-
-      it('returns a fulfilled promise with the new asset metric information', function() {
-        return expect(promise).to.be.fulfilled.and.to.eventually.deep.equal(
-          assetMetricFromServerAfterFormat
-        );
-      });
-    });
-
-    context('when there is missing required information', function() {
-      let assetMetric;
-      let assetMetrics;
-      let assetTypeId;
-      let promise;
-
-      beforeEach(function() {
-        assetMetric = fixture.build('assetMetric');
-        assetMetrics = new AssetMetrics(baseSdk, baseRequest, expectedHost);
-        assetTypeId = fixture.build('assetType').id;
-      });
-
-      it('throws an error if there is no asset type ID provided', function() {
-        promise = assetMetrics.create(null, assetMetric);
-
-        return expect(promise).to.be.rejectedWith(
-          'An asset type ID is required to create an asset metric.'
-        );
-      });
-
-      ['description', 'label', 'organizationId', 'timeInterval'].forEach(
-        (field) => {
-          it(`throws an error when ${field} is missing`, function() {
-            promise = assetMetrics.create(
-              assetTypeId,
-              omit(assetMetric, [field])
-            );
-
-            return expect(promise).to.be.rejectedWith(
-              `A ${field} is required to create a new asset metric.`
-            );
-          });
-        }
-      );
-    });
-  });
-
-  describe('delete', function() {
-    context('when all required information is supplied', function() {
-      let expectedAssetMetricId;
-      let promise;
-
-      beforeEach(function() {
-        expectedAssetMetricId = fixture.build('assetMetric').id;
-
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-
-        promise = assetMetrics.delete(expectedAssetMetricId);
-      });
-
-      it('requests to delete the asset metric', function() {
-        expect(baseRequest.delete).to.be.calledWith(
-          `${expectedHost}/assets/metrics/${expectedAssetMetricId}`
-        );
-      });
-
-      it('returns a fulfilled promise', function() {
-        return expect(promise).to.be.fulfilled;
-      });
-    });
-
-    context('when there is missing required information', function() {
-      it('throws an error when the asset metric ID is missing', function() {
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-
-        const promise = assetMetrics.delete();
-
-        return expect(promise).to.be.rejectedWith(
-          'An asset metric ID is required for deleting an asset metric.'
-        );
-      });
-    });
-  });
-
-  describe('get', function() {
-    context('the asset metric ID is provided', function() {
-      let assetMetricFromServerAfterFormat;
-      let assetMetricFromServerBeforeFormat;
-      let expectedAssetMetricId;
-      let promise;
-      let request;
-      let toCamelCase;
-
-      beforeEach(function() {
-        expectedAssetMetricId = fixture.build('assetMetric').id;
-        assetMetricFromServerAfterFormat = fixture.build('assetMetric', {
-          id: expectedAssetMetricId
-        });
-        assetMetricFromServerBeforeFormat = fixture.build(
-          'assetMetric',
-          assetMetricFromServerAfterFormat,
-          { fromServer: true }
-        );
-
-        request = {
-          ...baseRequest,
-          get: sinon.stub().resolves(assetMetricFromServerBeforeFormat)
-        };
-        toCamelCase = sinon
-          .stub(objectUtils, 'toCamelCase')
-          .returns(assetMetricFromServerAfterFormat);
-
-        const assetMetrics = new AssetMetrics(baseSdk, request, expectedHost);
-
-        promise = assetMetrics.get(expectedAssetMetricId);
-      });
-
-      it('gets the asset metric from the server', function() {
-        expect(request.get).to.be.calledWith(
-          `${expectedHost}/assets/metrics/${expectedAssetMetricId}`
-        );
-      });
-
-      it('formats the asset metric object', function() {
-        return promise.then(() => {
-          expect(toCamelCase).to.be.deep.calledWith(
-            assetMetricFromServerBeforeFormat
-          );
-        });
-      });
-
-      it('returns the requested asset metric', function() {
-        return expect(promise).to.be.fulfilled.and.to.eventually.deep.equal(
-          assetMetricFromServerAfterFormat
-        );
-      });
-    });
-
-    context('the asset metric ID is not provided', function() {
-      it('throws an error', function() {
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-        const promise = assetMetrics.get();
-
-        return expect(promise).to.be.rejectedWith(
-          'An asset metric ID is required for getting information about an asset metric.'
-        );
-      });
-    });
-  });
-
-  describe('getByAssetId', function() {
-    context('when all required information is supplied', function() {
-      let asset;
-      let formatPaginatedDataFromServer;
-      let numberOfAssetMetrics;
-      let metricsFiltersAfterFormat;
-      let metricsFiltersBeforeFormat;
-      let promise;
-      let request;
-      let toSnakeCase;
-      let valuesFromServerAfterFormat;
-      let valuesFromServerBeforeFormat;
-
-      beforeEach(function() {
-        numberOfAssetMetrics = faker.random.number({ min: 1, max: 10 });
-        asset = fixture.build('asset');
-        metricsFiltersBeforeFormat = {
-          limit: faker.random.number({ min: 10, max: 1000 }),
-          offset: faker.random.number({ max: 1000 })
-        };
-        metricsFiltersAfterFormat = {
-          limit: faker.random.number({ min: 10, max: 1000 }),
-          offset: faker.random.number({ max: 1000 })
-        };
-        valuesFromServerAfterFormat = {
-          _metadata: fixture.build('paginationMetadata'),
-          records: fixture.buildList('assetMetric', numberOfAssetMetrics, {
-            assetTypeId: asset.assetTypeId
-          })
-        };
-        valuesFromServerBeforeFormat = {
-          ...valuesFromServerAfterFormat,
-          records: valuesFromServerAfterFormat.records.map((values) =>
-            fixture.build('assetMetric', values, { fromServer: true })
-          )
-        };
-
-        formatPaginatedDataFromServer = sinon
-          .stub(paginationUtils, 'formatPaginatedDataFromServer')
-          .returns(valuesFromServerAfterFormat);
-        request = {
-          ...baseRequest,
-          get: sinon.stub().resolves(valuesFromServerBeforeFormat)
-        };
-        toSnakeCase = sinon
-          .stub(objectUtils, 'toSnakeCase')
-          .returns(metricsFiltersAfterFormat);
-
-        const assetMetrics = new AssetMetrics(baseSdk, request, expectedHost);
-        promise = assetMetrics.getByAssetId(
-          asset.id,
-          metricsFiltersBeforeFormat
-        );
-      });
-
-      it('formats the pagination options sent to the server', function() {
-        expect(toSnakeCase).to.be.calledWith(metricsFiltersBeforeFormat);
-      });
-
-      it('gets a list of the asset metrics from the server', function() {
-        expect(request.get).to.be.calledWith(
-          `${expectedHost}/assets/${asset.id}/metrics`,
-          { params: metricsFiltersAfterFormat }
-        );
-      });
-
-      it('formats the asset metric data', function() {
-        return promise.then(() => {
-          expect(formatPaginatedDataFromServer).to.be.calledWith(
-            valuesFromServerBeforeFormat
-          );
-        });
-      });
-
-      it('resolves with a list of asset metrics', function() {
-        return expect(promise).to.be.fulfilled.and.to.eventually.deep.equal(
-          valuesFromServerAfterFormat
-        );
-      });
-    });
-
-    context('when there is missing required information', function() {
-      let promise;
-
-      beforeEach(function() {
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-
-        promise = assetMetrics.getByAssetId();
-      });
-
-      it('throws an error when the asset type ID is missing', function() {
-        return expect(promise).to.be.rejectedWith(
-          'An asset ID is required to get a list of all asset metrics.'
-        );
-      });
-    });
-  });
-
-  describe('getByAssetTypeId', function() {
-    context('when all required information is supplied', function() {
-      let assetTypeId;
-      let formatPaginatedDataFromServer;
-      let numberOfAssetMetrics;
-      let metricsFiltersAfterFormat;
-      let metricsFiltersBeforeFormat;
-      let promise;
-      let request;
-      let toSnakeCase;
-      let valuesFromServerAfterFormat;
-      let valuesFromServerBeforeFormat;
-
-      beforeEach(function() {
-        numberOfAssetMetrics = faker.random.number({ min: 1, max: 10 });
-        assetTypeId = fixture.build('assetType').id;
-        metricsFiltersBeforeFormat = {
-          limit: faker.random.number({ min: 10, max: 1000 }),
-          offset: faker.random.number({ max: 1000 })
-        };
-        metricsFiltersAfterFormat = {
-          limit: faker.random.number({ min: 10, max: 1000 }),
-          offset: faker.random.number({ max: 1000 })
-        };
-        valuesFromServerAfterFormat = {
-          _metadata: fixture.build('paginationMetadata'),
-          records: fixture.buildList('assetMetric', numberOfAssetMetrics, {
-            assetTypeId
-          })
-        };
-        valuesFromServerBeforeFormat = {
-          ...valuesFromServerAfterFormat,
-          records: valuesFromServerAfterFormat.records.map((values) =>
-            fixture.build('assetMetric', values, { fromServer: true })
-          )
-        };
-
-        formatPaginatedDataFromServer = sinon
-          .stub(paginationUtils, 'formatPaginatedDataFromServer')
-          .returns(valuesFromServerAfterFormat);
-        request = {
-          ...baseRequest,
-          get: sinon.stub().resolves(valuesFromServerBeforeFormat)
-        };
-        toSnakeCase = sinon
-          .stub(objectUtils, 'toSnakeCase')
-          .returns(metricsFiltersAfterFormat);
-
-        const assetMetrics = new AssetMetrics(baseSdk, request, expectedHost);
-        promise = assetMetrics.getByAssetTypeId(
-          assetTypeId,
-          metricsFiltersBeforeFormat
-        );
-      });
-
-      it('formats the pagination options sent to the server', function() {
-        expect(toSnakeCase).to.be.calledWith(metricsFiltersBeforeFormat);
-      });
-
-      it('gets a list of the asset metrics from the server', function() {
-        expect(request.get).to.be.calledWith(
-          `${expectedHost}/assets/types/${assetTypeId}/metrics`,
-          { params: metricsFiltersAfterFormat }
-        );
-      });
-
-      it('formats the asset metric data', function() {
-        return promise.then(() => {
-          expect(formatPaginatedDataFromServer).to.be.calledWith(
-            valuesFromServerBeforeFormat
-          );
-        });
-      });
-
-      it('resolves with a list of asset metrics', function() {
-        return expect(promise).to.be.fulfilled.and.to.eventually.deep.equal(
-          valuesFromServerAfterFormat
-        );
-      });
-    });
-
-    context('when there is missing required information', function() {
-      let promise;
-
-      beforeEach(function() {
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-
-        promise = assetMetrics.getByAssetTypeId();
-      });
-
-      it('throws an error when the asset type ID is missing', function() {
-        return expect(promise).to.be.rejectedWith(
-          'An asset type ID is required to get a list of all asset metrics.'
-        );
-      });
-    });
-  });
-
-  describe('getValuesByMetricIdsAssetIds', function() {
-    let numberOfAssetMetricValues;
-    let numberOfAssetMetrics;
-    let numberOfAssets;
-
-    let assetMetricValuesCompact;
-    let assetMetricValuesCompactFromServer;
-    let assetMetricObjects;
-    let assets;
-
-    let metricsFiltersAfterFormat;
-    let metricsFiltersBeforeFormat;
-    let promise;
-    let request;
-    let toSnakeCase;
-    let strigifyParamsWithCommaSeparatedArrays;
-
-    let valuesFromServer;
-    let valuesFromServerFormatted;
-
-    beforeEach(function() {
-      numberOfAssetMetricValues = faker.random.number({ min: 1, max: 10 });
-      numberOfAssetMetrics = faker.random.number({ min: 1, max: 3 });
-      numberOfAssets = faker.random.number({ min: 1, max: 3 });
-
-      // camel case
-      assetMetricValuesCompact = fixture.buildList(
-        'assetMetricValueCompact',
-        numberOfAssetMetricValues
-      );
-
-      // snake case
-      assetMetricValuesCompactFromServer = fixture.buildList(
-        'assetMetricValueCompact',
-        numberOfAssetMetricValues,
-        null,
-        { fromServer: true }
-      );
-
-      assetMetricObjects = fixture.buildList(
-        'assetMetric',
-        numberOfAssetMetrics
-      );
-      assets = fixture.buildList('asset', numberOfAssets);
-
-      const metricObjects = assetMetricObjects.reduce((acc, metric) => {
-        return { ...acc, [metric.label]: assetMetricValuesCompactFromServer };
-      }, {});
-
-      valuesFromServer = assets.reduce((acc, asset) => {
-        return { ...acc, [asset.id]: { ...metricObjects } };
-      }, {});
-
-      const metricObjectsFormatted = assetMetricObjects.reduce(
-        (acc, metric) => {
-          return { ...acc, [metric.label]: assetMetricValuesCompact };
-        },
-        {}
-      );
-
-      valuesFromServerFormatted = assets.reduce((acc, asset) => {
-        return { ...acc, [asset.id]: { ...metricObjectsFormatted } };
-      }, {});
-
-      request = {
-        ...baseRequest,
-        get: sinon.stub().resolves(valuesFromServer)
-      };
-
-      metricsFiltersBeforeFormat = {
-        assetIds: assets.map((asset) => asset.id),
-        labels: assetMetricObjects.map((assetMetric) => assetMetric.label)
-      };
-
-      metricsFiltersAfterFormat = {
-        asset_ids: metricsFiltersBeforeFormat.assetIds,
-        labels: metricsFiltersBeforeFormat.labels
-      };
-
-      toSnakeCase = sinon
-        .stub(objectUtils, 'toSnakeCase')
-        .returns(metricsFiltersAfterFormat);
-
-      strigifyParamsWithCommaSeparatedArrays = sinon.stub(
-        urlUtils,
-        'stringifyParamsWithCommaSeparatedArrays'
-      );
-    });
-
-    context('when all required information is supplied', function() {
-      beforeEach(function() {
-        const assetMetrics = new AssetMetrics(baseSdk, request, expectedHost);
-        promise = assetMetrics.getValuesByMetricIdsAssetIds(
-          metricsFiltersBeforeFormat
-        );
-      });
-
-      it('called with the correctly formatted params', function() {
-        expect(request.get).to.be.calledWith(
-          `${expectedHost}/assets/metrics/values`,
-          {
-            params: metricsFiltersAfterFormat,
-            paramsSerializer: strigifyParamsWithCommaSeparatedArrays
-          }
-        );
-      });
-
-      it('resolves with a list of the asset metrics by asset id and label from the server', function() {
-        return expect(promise).to.be.fulfilled.and.to.eventually.deep.equal(
-          valuesFromServerFormatted
-        );
-      });
-
-      it('formats the url request params into the right format', function() {
-        expect(toSnakeCase).to.be.deep.calledWith(metricsFiltersBeforeFormat);
-      });
-    });
-
-    context('when any parameter is missing from filters', function() {
-      const missingParam = faker.random.arrayElement(['assetIds', 'labels']);
-
-      beforeEach(function() {
-        const assetMetrics = new AssetMetrics(baseSdk, request, expectedHost);
-        delete metricsFiltersBeforeFormat[missingParam];
-        promise = assetMetrics.getValuesByMetricIdsAssetIds(
-          metricsFiltersBeforeFormat
-        );
-      });
-
-      it('throws an Error', function() {
-        return expect(promise).to.be.eventually.rejectedWith(
-          `The ${missingParam} param is required to fetch data.`
-        );
-      });
-    });
-  });
-
-  describe('update', function() {
-    context('when all required information is supplied', function() {
-      let assetMetricToServerAfterFormat;
-      let assetMetricToServerBeforeFormat;
-      let toSnakeCase;
-      let promise;
-
-      beforeEach(function() {
-        assetMetricToServerAfterFormat = fixture.build('assetMetric', null, {
-          fromServer: true
-        });
-        assetMetricToServerBeforeFormat = fixture.build('assetMetric');
-
-        toSnakeCase = sinon
-          .stub(objectUtils, 'toSnakeCase')
-          .returns(assetMetricToServerAfterFormat);
-
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-
-        promise = assetMetrics.update(
-          assetMetricToServerBeforeFormat.id,
-          assetMetricToServerBeforeFormat
-        );
-      });
-
-      it('formats the data into the right format', function() {
-        expect(toSnakeCase).to.be.deep.calledWith(
-          assetMetricToServerBeforeFormat,
-          {
-            excludeKeys: [
-              'createdAt',
-              'id',
-              'label',
-              'organizationId',
-              'updatedAt'
-            ]
-          }
-        );
-      });
-
-      it('updates the asset metric', function() {
-        expect(baseRequest.put).to.be.deep.calledWith(
-          `${expectedHost}/assets/metrics/${
-            assetMetricToServerBeforeFormat.id
-          }`,
-          assetMetricToServerAfterFormat
-        );
-      });
-
-      it('returns a fulfilled promise', function() {
-        return expect(promise).to.be.fulfilled;
-      });
-    });
-
-    context(
-      'when there is missing or malformed required information',
-      function() {
-        let assetMetrics;
-
-        beforeEach(function() {
-          assetMetrics = new AssetMetrics(baseSdk, baseRequest, expectedHost);
-        });
-
-        it('throws an error when there is no provided asset metric ID', function() {
-          const assetAttributeUpdate = fixture.build('assetMetric');
-          const promise = assetMetrics.update(null, assetAttributeUpdate);
-
-          return expect(promise).to.be.rejectedWith(
-            'An asset metric ID is required to update an asset metric.'
-          );
-        });
-
-        it('throws an error when there is no update provided', function() {
-          const assetAttributeUpdate = fixture.build('assetMetric');
-          const promise = assetMetrics.update(assetAttributeUpdate.id);
-
-          return expect(promise).to.be.rejectedWith(
-            'An update is required to update an asset metric.'
-          );
-        });
-
-        it('throws an error when the update is not a well-formed object', function() {
-          const assetAttributeUpdate = fixture.build('assetMetric');
-          const promise = assetMetrics.update(assetAttributeUpdate.id, [
-            assetAttributeUpdate
-          ]);
-
-          return expect(promise).to.be.rejectedWith(
-            'The asset metric update must be a well-formed object with the data you wish to update.'
-          );
-        });
-      }
-    );
-  });
-
-  describe('createValue', function() {
-    context('when all required information is supplied', function() {
-      let assetId;
-      let promise;
-      let request;
-      let toCamelCase;
-      let toSnakeCase;
-      let valueFromServerAfterFormat;
-      let valueFromServerBeforeFormat;
-      let valueToServerAfterFormat;
-      let valueToServerBeforeFormat;
-
-      beforeEach(function() {
-        valueToServerBeforeFormat = fixture.build('assetMetricValue');
-        valueToServerAfterFormat = fixture.build(
-          'assetMetricValue',
-          valueToServerBeforeFormat,
-          {
-            fromServer: true
-          }
-        );
-        valueFromServerAfterFormat = fixture.build('assetMetricValue');
-        valueFromServerBeforeFormat = fixture.build(
-          'assetMetricValue',
-          valueFromServerAfterFormat,
-          { fromServer: true }
-        );
-        assetId = fixture.build('asset').id;
-
-        request = {
-          ...baseRequest,
-          post: sinon.stub().resolves(valueFromServerBeforeFormat)
-        };
-        toCamelCase = sinon
-          .stub(objectUtils, 'toCamelCase')
-          .returns(valueFromServerAfterFormat);
-        toSnakeCase = sinon
-          .stub(objectUtils, 'toSnakeCase')
-          .returns(valueToServerAfterFormat);
-
-        const assetMetrics = new AssetMetrics(baseSdk, request, expectedHost);
-
-        promise = assetMetrics.createValue(assetId, valueToServerBeforeFormat);
-      });
-
-      it('formats the submitted asset metric value object to send to the server ', function() {
-        expect(toSnakeCase).to.be.calledWith(valueToServerBeforeFormat);
-      });
-
-      it('creates a new asset metric value', function() {
-        expect(request.post).to.be.calledWith(
-          `${expectedHost}/assets/${assetId}/metrics/${
-            valueToServerBeforeFormat.assetMetricId
-          }/values`,
-          valueToServerAfterFormat
-        );
-      });
-
-      it('formats the returned asset metric value object', function() {
-        return promise.then(() => {
-          expect(toCamelCase).to.be.calledWith(valueFromServerBeforeFormat);
-        });
-      });
-
-      it('returns a fulfilled promise with the new asset metric value information', function() {
-        return expect(promise).to.be.fulfilled.and.to.eventually.deep.equal(
-          valueFromServerAfterFormat
-        );
-      });
-    });
-
-    context('when there is missing required information', function() {
-      let value;
-      let assetMetrics;
-
-      beforeEach(function() {
-        value = fixture.build('assetMetricValue');
-
-        assetMetrics = new AssetMetrics(baseSdk, baseRequest, expectedHost);
-      });
-
-      it('throws an error if there is no asset ID provided', function() {
-        const promise = assetMetrics.createValue(null, value);
-
-        return expect(promise).to.be.rejectedWith(
-          'An asset ID is required to create a new asset metric value.'
-        );
-      });
-
-      [
-        'assetMetricId',
-        'effectiveEndDate',
-        'effectiveStartDate',
-        'value'
-      ].forEach(function(field) {
-        it(`throws an error when ${field} is missing`, function() {
-          const promise = assetMetrics.createValue(
-            value.id,
-            omit(value, [field])
-          );
-
-          return expect(promise).to.be.rejectedWith(
-            `A ${field} is required to create a new asset metric value.`
-          );
-        });
-      });
-    });
-  });
-
-  describe('deleteValue', function() {
-    context('when all required information is supplied', function() {
-      let valueId;
-      let promise;
-
-      beforeEach(function() {
-        valueId = fixture.build('assetMetricValue').id;
-
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-
-        promise = assetMetrics.deleteValue(valueId);
-      });
-
-      it('requests to delete the asset metric value', function() {
-        expect(baseRequest.delete).to.be.calledWith(
-          `${expectedHost}/assets/metrics/values/${valueId}`
-        );
-      });
-
-      it('returns a fulfilled promise', function() {
-        return expect(promise).to.be.fulfilled;
-      });
-    });
-
-    context('when there is missing required information', function() {
-      it('throws an error when the asset metric value ID is missing', function() {
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-
-        const promise = assetMetrics.deleteValue();
-
-        return expect(promise).to.be.rejectedWith(
-          'An asset metric value ID is required for deleting an asset metric value.'
-        );
-      });
-    });
-  });
-
-  describe('getValuesByAssetId', function() {
-    context('when all required information is supplied', function() {
-      let assetId;
-      let formatPaginatedDataFromServer;
-      let metricValuesFiltersBeforeFormat;
-      let metricValuesFiltersAfterFormat;
-      let promise;
-      let request;
-      let toSnakeCase;
-      let valuesFromServerAfterFormat;
-      let valuesFromServerBeforeFormat;
-
-      beforeEach(function() {
-        assetId = fixture.build('asset').id;
-        metricValuesFiltersBeforeFormat = {
-          limit: faker.random.number({ min: 10, max: 1000 }),
-          offset: faker.random.number({ max: 1000 })
-        };
-        metricValuesFiltersAfterFormat = {
-          limit: faker.random.number({ min: 10, max: 1000 }),
-          offset: faker.random.number({ max: 1000 })
-        };
-        valuesFromServerAfterFormat = {
-          _metadata: fixture.build('paginationMetadata'),
-          records: fixture.buildList(
-            'assetMetricValue',
-            faker.random.number({ min: 1, max: 20 }),
-            { assetId }
-          )
-        };
-        valuesFromServerBeforeFormat = {
-          ...valuesFromServerAfterFormat,
-          records: valuesFromServerAfterFormat.records.map((values) =>
-            fixture.build('assetMetricValue', values, { fromServer: true })
-          )
-        };
-
-        formatPaginatedDataFromServer = sinon
-          .stub(paginationUtils, 'formatPaginatedDataFromServer')
-          .returns(valuesFromServerAfterFormat);
-        request = {
-          ...baseRequest,
-          get: sinon.stub().resolves(valuesFromServerBeforeFormat)
-        };
-        toSnakeCase = sinon
-          .stub(objectUtils, 'toSnakeCase')
-          .returns(metricValuesFiltersAfterFormat);
-
-        const assetMetrics = new AssetMetrics(baseSdk, request, expectedHost);
-        promise = assetMetrics.getValuesByAssetId(
-          assetId,
-          metricValuesFiltersBeforeFormat
-        );
-      });
-
-      it('formats the pagination options sent to the server', function() {
-        expect(toSnakeCase).to.be.calledWith(metricValuesFiltersBeforeFormat);
-      });
-
-      it('gets a list of asset metric values from the server', function() {
-        expect(request.get).to.be.calledWith(
-          `${expectedHost}/assets/${assetId}/metrics/values`,
-          { params: metricValuesFiltersAfterFormat }
-        );
-      });
-
-      it('formats the asset metric value data', function() {
-        return promise.then(() => {
-          expect(formatPaginatedDataFromServer).to.be.calledWith(
-            valuesFromServerBeforeFormat
-          );
-        });
-      });
-
-      it('resolves with a list of asset metric values', function() {
-        return expect(promise).to.be.fulfilled.and.to.eventually.deep.equal(
-          valuesFromServerAfterFormat
-        );
-      });
-    });
-
-    context('when there is missing required information', function() {
-      it('throws an error when the asset ID is missing', function() {
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-        const promise = assetMetrics.getValuesByMetricId();
-
-        return expect(promise).to.be.rejectedWith(
-          'An asset ID is required to get a list of asset metric values.'
-        );
-      });
-    });
-  });
-
-  describe('getValuesByMetricId', function() {
-    context('when all required information is supplied', function() {
-      let assetId;
-      let metricId;
-      let formatPaginatedDataFromServer;
-      let metricValuesFiltersBeforeFormat;
-      let metricValuesFiltersAfterFormat;
-      let promise;
-      let request;
-      let toSnakeCase;
-      let valuesFromServerAfterFormat;
-      let valuesFromServerBeforeFormat;
-
-      beforeEach(function() {
-        assetId = fixture.build('asset').id;
-        metricId = fixture.build('assetMetric').id;
-        metricValuesFiltersBeforeFormat = {
-          limit: faker.random.number({ min: 10, max: 1000 }),
-          offset: faker.random.number({ max: 1000 })
-        };
-        metricValuesFiltersAfterFormat = {
-          limit: faker.random.number({ min: 10, max: 1000 }),
-          offset: faker.random.number({ max: 1000 })
-        };
-        valuesFromServerAfterFormat = {
-          _metadata: fixture.build('paginationMetadata'),
-          records: fixture.buildList(
-            'assetMetricValue',
-            faker.random.number({ min: 1, max: 20 }),
-            {
-              assetId,
-              assetMetricId: metricId
-            }
-          )
-        };
-        valuesFromServerBeforeFormat = {
-          ...valuesFromServerAfterFormat,
-          records: valuesFromServerAfterFormat.records.map((values) =>
-            fixture.build('assetMetricValue', values, { fromServer: true })
-          )
-        };
-
-        formatPaginatedDataFromServer = sinon
-          .stub(paginationUtils, 'formatPaginatedDataFromServer')
-          .returns(valuesFromServerAfterFormat);
-        request = {
-          ...baseRequest,
-          get: sinon.stub().resolves(valuesFromServerBeforeFormat)
-        };
-        toSnakeCase = sinon
-          .stub(objectUtils, 'toSnakeCase')
-          .returns(metricValuesFiltersAfterFormat);
-
-        const assetMetrics = new AssetMetrics(baseSdk, request, expectedHost);
-        promise = assetMetrics.getValuesByMetricId(
-          assetId,
-          metricId,
-          metricValuesFiltersBeforeFormat
-        );
-      });
-
-      it('formats the pagination options sent to the server', function() {
-        expect(toSnakeCase).to.be.calledWith(metricValuesFiltersBeforeFormat);
-      });
-
-      it('gets a list of asset metric values from the server', function() {
-        expect(request.get).to.be.calledWith(
-          `${expectedHost}/assets/${assetId}/metrics/${metricId}/values`,
-          { params: metricValuesFiltersAfterFormat }
-        );
-      });
-
-      it('formats the asset metric value data', function() {
-        return promise.then(() => {
-          expect(formatPaginatedDataFromServer).to.be.calledWith(
-            valuesFromServerBeforeFormat
-          );
-        });
-      });
-
-      it('resolves with a list of asset metric values', function() {
-        return expect(promise).to.be.fulfilled.and.to.eventually.deep.equal(
-          valuesFromServerAfterFormat
-        );
-      });
-    });
-
-    context('when there is missing required information', function() {
-      it('throws an error when the asset ID is missing', function() {
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-        const promise = assetMetrics.getValuesByMetricId(
-          null,
-          fixture.build('assetMetric').id
-        );
-
-        return expect(promise).to.be.rejectedWith(
-          'An asset ID is required to get a list of asset metric values.'
-        );
-      });
-
-      it('throws an error when the asset metric ID is missing', function() {
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-        const promise = assetMetrics.getValuesByMetricId(
-          fixture.build('asset').id,
-          null
-        );
-
-        return expect(promise).to.be.rejectedWith(
-          'An asset metric ID is required to get a list of asset metric values.'
-        );
-      });
-    });
-  });
-
-  describe('updateValue', function() {
-    context('when all required information is supplied', function() {
-      let promise;
-      let toSnakeCase;
-      let valueToServerAfterFormat;
-      let valueToServerBeforeFormat;
-
-      beforeEach(function() {
-        valueToServerBeforeFormat = fixture.build('assetMetricValue');
-        valueToServerAfterFormat = fixture.build(
-          'assetMetricValue',
-          valueToServerBeforeFormat,
-          { fromServer: true }
-        );
-
-        toSnakeCase = sinon
-          .stub(objectUtils, 'toSnakeCase')
-          .returns(valueToServerAfterFormat);
-
-        const assetMetrics = new AssetMetrics(
-          baseSdk,
-          baseRequest,
-          expectedHost
-        );
-
-        promise = assetMetrics.updateValue(
-          valueToServerBeforeFormat.id,
-          valueToServerBeforeFormat
-        );
-      });
-
-      it('formats the data into the right format', function() {
-        expect(toSnakeCase).to.calledWith(valueToServerBeforeFormat, {
-          excludeKeys: ['assetId', 'assetMetricId', 'id']
-        });
-      });
-
-      it('updates the asset metric value', function() {
-        expect(baseRequest.put).to.be.calledWith(
-          `${expectedHost}/assets/metrics/values/${
-            valueToServerAfterFormat.id
-          }`,
-          valueToServerAfterFormat
-        );
-      });
-
-      it('returns a fulfilled promise', function() {
-        return expect(promise).to.be.fulfilled;
-      });
-    });
-
-    context(
-      'when there is missing or malformed required information',
-      function() {
-        let assetMetrics;
-
-        beforeEach(function() {
-          assetMetrics = new AssetMetrics(baseSdk, baseRequest, expectedHost);
-        });
-
-        it('throws an error when there is not provided asset metric value ID', function() {
-          const valueUpdate = fixture.build('assetMetricValue');
-          const promise = assetMetrics.updateValue(null, valueUpdate);
-
-          return expect(promise).to.be.rejectedWith(
-            'An asset metric value ID is required to update an asset metric value.'
-          );
-        });
-
-        it('throws an error when there is no update provided', function() {
-          const valueUpdate = fixture.build('assetMetricValue');
-          const promise = assetMetrics.updateValue(valueUpdate.id);
-
-          return expect(promise).to.be.rejectedWith(
-            'An update is required to update an asset metric value.'
-          );
-        });
-
-        it('throws an error when the update is not a well-formed object', function() {
-          const valueUpdate = fixture.build('assetMetricValue');
-          const promise = assetMetrics.updateValue(valueUpdate.id, [
-            valueUpdate
-          ]);
-
-          return expect(promise).to.be.rejectedWith(
-            'The asset metric value update must be a well-formed object with the data you wish to update.'
-          );
-        });
-      }
-    );
-  });
-});