@adobe/spacecat-shared-rum-api-client 1.5.0 → 1.6.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-rum-api-client-v1.6.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.6.0...@adobe/spacecat-shared-rum-api-client-v1.6.1) (2024-02-07)
+
+
+### Bug Fixes
+
+* Experimentation RUM API call ([#141](https://github.com/adobe/spacecat-shared/issues/141)) ([2f1e657](https://github.com/adobe/spacecat-shared/commit/2f1e657d747c06a5728740e6687b1add77df9d70))
+
+# [@adobe/spacecat-shared-rum-api-client-v1.6.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.5.0...@adobe/spacecat-shared-rum-api-client-v1.6.0) (2024-02-07)
+
+
+### Features
+
+* experimentation RUM API method ([#133](https://github.com/adobe/spacecat-shared/issues/133)) ([f95eded](https://github.com/adobe/spacecat-shared/commit/f95ededcc5ba373717a90a577f20e75e1fad80d4))
+
 # [@adobe/spacecat-shared-rum-api-client-v1.5.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v1.4.4...@adobe/spacecat-shared-rum-api-client-v1.5.0) (2024-02-06)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "main": "src/index.js",

package/src/index.d.ts

@@ -66,6 +66,22 @@ export default class RUMAPIClient {
    */
   getRUMDashboard(params?: RUMAPIOptions): Promise<Array<object>>;
 
+  /**
+   * Asynchronous method to return the Experimentation API call response data.
+   * @param {RUMAPIOptions} params - An object representing the parameters to be included
+   *  for the Experimentation data API call.
+   * @returns A Promise resolving to the Experimentation response data.
+   */
+  getExperimentationData(params?: RUMAPIOptions): Promise<Array<object>>;
+
+  /**
+   * Method to return the url composed of params that the Experimentation API is called with.
+   * @param {RUMAPIOptions} params - An object representing the parameters to be included
+   *  for the Experimentation API call.
+   * @returns A string returning the Experimentation url including query parameters.
+   */
+  createExperimentationURL(params?: RUMAPIOptions): string;
+
   /**
    * Asynchronous method to return the 404 sources API call response data.
    * @param {RUMAPIOptions} params - An object representing the parameters to be included

package/src/index.js

@@ -22,6 +22,7 @@ const APIS = {
   RUM_DASHBOARD: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rum-dashboard',
   DOMAIN_LIST: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/dash/domain-list',
   RUM_SOURCES: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rum-sources',
+  RUM_EXPERIMENTS: 'https://helix-pages.anywhere.run/helix-services/run-query@v3/rum-experiments',
 };
 
 const DOMAIN_LIST_DEFAULT_PARAMS = {
@@ -133,6 +134,19 @@ export default class RUMAPIClient {
     return sendRequest(this.createRUMURL(params));
   }
 
+  createExperimentationURL(params = {}) {
+    return createUrl(
+      APIS.RUM_EXPERIMENTS,
+      {
+        domainkey: this.domainkey, ...RUM_DEFAULT_PARAMS, ...params,
+      },
+    );
+  }
+
+  async getExperimentationData(params = {}) {
+    return sendRequest(this.createExperimentationURL(params));
+  }
+
   async get404Sources(params = {}) {
     return sendRequest(this.create404URL(params));
   }