Fix tests

lib/mux/data/errors.ex

@@ -8,17 +8,17 @@ defmodule Mux.Data.Errors do
   @doc """
   Returns a list of playback errors along with details and statistics about them.
 
-  Returns `{:ok, errors, raw_env}`.
+  Returns `{:ok, raw_env | errors}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, errors, _env} = Mux.Data.Errors.list(client)
+      iex> {:ok, %{clean_body: errors} = _env} = Mux.Data.Errors.list(client)
       iex> errors
       #{inspect(Fixtures.errors()["data"])}
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, errors, _env} = Mux.Data.Errors.list(client, filters: ["operating_system:windows"], timeframe: ["24:hours"])
+      iex> {:ok, %{clean_body: errors} = _env} = Mux.Data.Errors.list(client, filters: ["operating_system:windows"], timeframe: ["24:hours"])
       iex> errors
       #{inspect(Fixtures.errors()["data"])}
 

lib/mux/data/exports.ex

@@ -11,12 +11,12 @@ defmodule Mux.Data.Exports do
   @doc """
   Lists the available video view exports along with URLs to retrieve them.
 
-  Returns `{:ok, exports, raw_env}`.
+  Returns `{:ok, raw_env | exports}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, exports, _env} = Mux.Data.Exports.list(client)
+      iex> {:ok, %{clean_body: exports} = _env} = Mux.Data.Exports.list(client)
       iex> exports
       #{inspect(Fixtures.exports()["data"])}
 

lib/mux/data/filters.ex

@@ -13,7 +13,7 @@ defmodule Mux.Data.Filters do
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, filters, _env} = Mux.Data.Filters.list(client)
+      iex> {:ok, %{clean_body: filters} = _env} = Mux.Data.Filters.list(client)
       iex> filters
       #{inspect(Fixtures.filters()["data"])}
 
@@ -25,12 +25,12 @@ defmodule Mux.Data.Filters do
   @doc """
   Lists the values for a specific filter along with a total count of related views.
 
-  Returns `{:ok, filters, raw_env}`.
+  Returns `{:ok, raw_env | filters}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, filters, _env} = Mux.Data.Filters.get(client, "browser")
+      iex> {:ok, %{clean_body: filters} = _env} = Mux.Data.Filters.get(client, "browser")
       iex> filters
       #{inspect(Fixtures.filters(:browser)["data"])}
 

lib/mux/data/incidents.ex

@@ -8,12 +8,12 @@ defmodule Mux.Data.Incidents do
   @doc """
   Lists all incidents.
 
-  Returns `{:ok, incidents, raw_env}`.
+  Returns `{:ok, raw_env | incidents}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, incidents, _env} = Mux.Data.Incidents.list(client, status: 'open', severity: 'alert')
+      iex> {:ok, %{clean_body: incidents} = _env} = Mux.Data.Incidents.list(client, status: 'open', severity: 'alert')
       iex> incidents
       #{inspect(Fixtures.incidents()["data"])}
 
@@ -25,12 +25,12 @@ defmodule Mux.Data.Incidents do
   @doc """
   Lists details for a single incident.
 
-  Returns `{:ok, incident, raw_env}`.
+  Returns `{:ok, raw_env | incident}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, incident, _env} = Mux.Data.Incidents.get(client, "ABCD1234")
+      iex> {:ok, %{clean_body: incident} = _env} = Mux.Data.Incidents.get(client, "ABCD1234")
       iex> incident
       #{inspect(Fixtures.incident()["data"])}
 
@@ -42,12 +42,12 @@ defmodule Mux.Data.Incidents do
   @doc """
   Lists all the incidents that seem related to a specific incident.
 
-  Returns `{:ok, incidents, raw_env}`.
+  Returns `{:ok, raw_env | incidents}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, incidents, _env} = Mux.Data.Incidents.related(client, "ABCD1234", measurement: "median")
+      iex> {:ok, %{clean_body: incidents} = _env} = Mux.Data.Incidents.related(client, "ABCD1234", measurement: "median")
       iex> incidents
       #{inspect(Fixtures.related_incidents()["data"])}
 

lib/mux/data/metrics.ex

@@ -15,17 +15,17 @@ defmodule Mux.Data.Metrics do
   @doc """
   List the breakdown values for a specific metric.
 
-  Returns `{:ok, breakdowns, raw_env}`.
+  Returns `{:ok, raw_env | breakdowns}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, breakdowns, _env} = Mux.Data.Metrics.breakdown(client, "video_startup_time", "browser")
+      iex> {:ok, %{clean_body: breakdowns} = _env} = Mux.Data.Metrics.breakdown(client, "video_startup_time", "browser")
       iex> breakdowns
       #{inspect(Fixtures.breakdown()["data"])}
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, breakdowns, _env} = Mux.Data.Metrics.breakdown(client, "video_startup_time", "browser", measurement: "median", timeframe: ["6:hours"])
+      iex> {:ok, %{clean_body: breakdowns} = _env} = Mux.Data.Metrics.breakdown(client, "video_startup_time", "browser", measurement: "median", timeframe: ["6:hours"])
       iex> breakdowns
       #{inspect(Fixtures.breakdown()["data"])}
 
@@ -39,12 +39,12 @@ defmodule Mux.Data.Metrics do
   @doc """
   List all of the values across every breakdown for a specific breakdown value.
 
-  Returns `{:ok, comparisons, raw_env}`.
+  Returns `{:ok, raw_env | comparisons}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, comparison, _env} = Mux.Data.Metrics.comparison(client, "browser", "Safari")
+      iex> {:ok, %{clean_body: comparison} = _env} = Mux.Data.Metrics.comparison(client, "browser", "Safari")
       iex> comparison
       #{inspect(Fixtures.comparison()["data"])}
 
@@ -58,12 +58,12 @@ defmodule Mux.Data.Metrics do
   Returns a list of insights for a metric. These are the worst performing values across all breakdowns
   sorted by how much they negatively impact a specific metric.
 
-  Returns `{:ok, insights, raw_env}`.
+  Returns `{:ok, raw_env | insights}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, insights, _env} = Mux.Data.Metrics.insights(client, "video_startup_time")
+      iex> {:ok, %{clean_body: insights} = _env} = Mux.Data.Metrics.insights(client, "video_startup_time")
       iex> insights
       #{inspect(Fixtures.insights()["data"])}
 
@@ -76,12 +76,12 @@ defmodule Mux.Data.Metrics do
   Returns the overall value for a specific metric, as well as the total view count, watch time, and
   the Mux Global metric value for the metric.
 
-  Returns `{:ok, overall_values, raw_env}`.
+  Returns `{:ok, raw_env | overall_values}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, insights, _env} = Mux.Data.Metrics.overall(client, "video_startup_time")
+      iex> {:ok, %{clean_body: insights} = _env} = Mux.Data.Metrics.overall(client, "video_startup_time")
       iex> insights
       #{inspect(Fixtures.overall()["data"])}
 
@@ -93,12 +93,12 @@ defmodule Mux.Data.Metrics do
   @doc """
   Returns time series data for a given metric.
 
-  Returns `{:ok, timeseries, raw_env}`.
+  Returns `{:ok, raw_env | timeseries}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, timeseries, _env} = Mux.Data.Metrics.timeseries(client, "video_startup_time")
+      iex> {:ok, %{clean_body: timeseries} = _env} = Mux.Data.Metrics.timeseries(client, "video_startup_time")
       iex> timeseries
       #{inspect(Fixtures.timeseries()["data"])}
 

lib/mux/data/real_time.ex

@@ -14,12 +14,12 @@ defmodule Mux.Data.RealTime do
   @doc """
   List of available real-time dimensions
 
-  Returns `{:ok, dimensions, raw_env}`.
+  Returns `{:ok, raw_env | dimensions}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, dimensions, _env} = Mux.Data.RealTime.dimensions(client)
+      iex> {:ok, %{clean_body: dimensions} = _env} = Mux.Data.RealTime.dimensions(client)
       iex> dimensions
       #{inspect(Fixtures.realtime_dimensions()["data"])}
 
@@ -31,12 +31,12 @@ defmodule Mux.Data.RealTime do
   @doc """
   List of available real-time metrics
 
-  Returns `{:ok, metrics, raw_env}`.
+  Returns `{:ok, raw_env | metrics}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, metrics, _env} = Mux.Data.RealTime.metrics(client)
+      iex> {:ok, %{clean_body: metrics} = _env} = Mux.Data.RealTime.metrics(client)
       iex> metrics
       #{inspect(Fixtures.realtime_metrics()["data"])}
 
@@ -48,12 +48,12 @@ defmodule Mux.Data.RealTime do
   @doc """
   Get breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.
 
-  Returns `{:ok, breakdown, raw_env}`.
+  Returns `{:ok, raw_env | breakdown}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, breakdown, _env} = Mux.Data.RealTime.breakdown(client, "playback-failure-percentage", dimension: "country", timestamp: 1_547_853_000, filters: ["operating_system:windows"])
+      iex> {:ok, %{clean_body: breakdown} = _env} = Mux.Data.RealTime.breakdown(client, "playback-failure-percentage", dimension: "country", timestamp: 1_547_853_000, filters: ["operating_system:windows"])
       iex> breakdown
       #{inspect(Fixtures.realtime_breakdown()["data"])}
 
@@ -65,12 +65,12 @@ defmodule Mux.Data.RealTime do
   @doc """
   List histogram timeseries information for a specific metric
 
-  Returns `{:ok, histogram_timeseries, raw_env}`.
+  Returns `{:ok, raw_env | histogram_timeseries}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, histogram_timeseries, _env} = Mux.Data.RealTime.histogram_timeseries(client, "video-startup-time", filters: ["operating_system:windows", "country:US"])
+      iex> {:ok, %{clean_body: histogram_timeseries} = _env} = Mux.Data.RealTime.histogram_timeseries(client, "video-startup-time", filters: ["operating_system:windows", "country:US"])
       iex> histogram_timeseries
       #{inspect(Fixtures.realtime_histogram_timeseries()["data"])}
 
@@ -82,12 +82,12 @@ defmodule Mux.Data.RealTime do
   @doc """
   List timeseries information for a specific metric along with the number of concurrent viewers.
 
-  Returns `{:ok, timeseries, raw_env}`.
+  Returns `{:ok, raw_env | timeseries}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, timeseries, _env} = Mux.Data.RealTime.timeseries(client, "playback-failure-percentage", filters: ["operating_system:windows", "country:US"])
+      iex> {:ok, %{clean_body: timeseries} = _env} = Mux.Data.RealTime.timeseries(client, "playback-failure-percentage", filters: ["operating_system:windows", "country:US"])
       iex> timeseries
       #{inspect(Fixtures.realtime_timeseries()["data"])}
 

lib/mux/data/video_views.ex

@@ -11,17 +11,17 @@ defmodule Mux.Data.VideoViews do
   timeframe. Results are ordered by `view_end`, according to what you provide for
   `order_direction`.
 
-  Returns `{:ok, views, raw_env}`.
+  Returns `{:ok, raw_env | views}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, views, _env} = Mux.Data.VideoViews.list(client)
+      iex> {:ok, %{clean_body: views} = _env} = Mux.Data.VideoViews.list(client)
       iex> views
       #{inspect(Fixtures.video_views()["data"])}
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, views, _env} = Mux.Data.VideoViews.list(client, filters: ["browser:Chrome"], order_direction: "desc", page: 2)
+      iex> {:ok, %{clean_body: views} = _env} = Mux.Data.VideoViews.list(client, filters: ["browser:Chrome"], order_direction: "desc", page: 2)
       iex> views
       #{inspect(Fixtures.video_views()["data"])}
 
@@ -33,12 +33,12 @@ defmodule Mux.Data.VideoViews do
   @doc """
   Returns the details for a single video view.
 
-  Returns `{:ok, view, raw_env}`.
+  Returns `{:ok, raw_env | view}`.
 
   ## Examples
 
       iex> client = Mux.client("my_token_id", "my_token_secret")
-      iex> {:ok, view, _env} = Mux.Data.VideoViews.get(client, "k8n4aklUyrRDekILDWta1qSJqNFpYB7N50")
+      iex> {:ok, %{clean_body: view} = _env} = Mux.Data.VideoViews.get(client, "k8n4aklUyrRDekILDWta1qSJqNFpYB7N50")
       iex> view["id"] === "k8n4aklUyrRDekILDWta1qSJqNFpYB7N50"
       true