mux_ruby 1.6.0 → 2.0.0.pre.rc.2

data/docs/VideoViewEvent.md

@@ -1,11 +1,24 @@
 # MuxRuby::VideoViewEvent
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**viewer_time** | **Integer** |  | [optional] 
-**playback_time** | **Integer** |  | [optional] 
-**name** | **String** |  | [optional] 
-**event_time** | **Integer** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **viewer_time** | **Integer** |  | [optional] |
+| **playback_time** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **event_time** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::VideoViewEvent.new(
+  viewer_time: null,
+  playback_time: null,
+  name: null,
+  event_time: null
+)
+```
 

data/docs/VideoViewResponse.md

@@ -1,9 +1,20 @@
 # MuxRuby::VideoViewResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**VideoView**](.md) |  | [optional] 
-**timeframe** | **Array<Integer>** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**VideoView**](.md) |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::VideoViewResponse.new(
+  data: null,
+  timeframe: null
+)
+```
 

data/docs/VideoViewsApi.md

@@ -2,22 +2,24 @@
 
 All URIs are relative to *https://api.mux.com*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_video_view**](VideoViewsApi.md#get_video_view) | **GET** /data/v1/video-views/{VIDEO_VIEW_ID} | Get a Video View
-[**list_video_views**](VideoViewsApi.md#list_video_views) | **GET** /data/v1/video-views | List Video Views
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_video_view**](VideoViewsApi.md#get_video_view) | **GET** /data/v1/video-views/{VIDEO_VIEW_ID} | Get a Video View |
+| [**list_video_views**](VideoViewsApi.md#list_video_views) | **GET** /data/v1/video-views | List Video Views |
 
 
-# **get_video_view**
-> VideoViewResponse get_video_view(video_view_id)
+## get_video_view
+
+> <VideoViewResponse> get_video_view(video_view_id)
 
 Get a Video View
 
-Returns the details of a video view 
+Returns the details of a video view.
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -30,19 +32,37 @@ api_instance = MuxRuby::VideoViewsApi.new
 video_view_id = 'abcd1234' # String | ID of the Video View
 
 begin
-  #Get a Video View
+  # Get a Video View
   result = api_instance.get_video_view(video_view_id)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling VideoViewsApi->get_video_view: #{e}"
+  puts "Error when calling VideoViewsApi->get_video_view: #{e}"
+end
+```
+
+#### Using the get_video_view_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VideoViewResponse>, Integer, Hash)> get_video_view_with_http_info(video_view_id)
+
+```ruby
+begin
+  # Get a Video View
+  data, status_code, headers = api_instance.get_video_view_with_http_info(video_view_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VideoViewResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling VideoViewsApi->get_video_view_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **video_view_id** | **String**| ID of the Video View | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **video_view_id** | **String** | ID of the Video View |  |
 
 ### Return type
 
@@ -54,21 +74,22 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## list_video_views
 
-# **list_video_views**
-> ListVideoViewsResponse list_video_views(opts)
+> <ListVideoViewsResponse> list_video_views(opts)
 
 List Video Views
 
-Returns a list of video views 
+Returns a list of video views.
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -79,35 +100,53 @@ end
 
 api_instance = MuxRuby::VideoViewsApi.new
 opts = {
-  limit: 25, # Integer | Number of items to include in the response
-  page: 1, # Integer | Offset by this many pages, of the size of `limit`
+  limit: 56, # Integer | Number of items to include in the response
+  page: 56, # Integer | Offset by this many pages, of the size of `limit`
   viewer_id: 'viewer_id_example', # String | Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux.
   error_id: 56, # Integer | Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error.
-  order_direction: 'order_direction_example', # String | Sort order.
-  filters: ['filters_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
-  timeframe: ['timeframe_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...   * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600    * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days. 
+  order_direction: 'asc', # String | Sort order.
+  filters: ['inner_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. 
+  timeframe: ['inner_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...   * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600   * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days. 
 }
 
 begin
-  #List Video Views
+  # List Video Views
   result = api_instance.list_video_views(opts)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling VideoViewsApi->list_video_views: #{e}"
+  puts "Error when calling VideoViewsApi->list_video_views: #{e}"
+end
+```
+
+#### Using the list_video_views_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListVideoViewsResponse>, Integer, Hash)> list_video_views_with_http_info(opts)
+
+```ruby
+begin
+  # List Video Views
+  data, status_code, headers = api_instance.list_video_views_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListVideoViewsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling VideoViewsApi->list_video_views_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| Number of items to include in the response | [optional] [default to 25]
- **page** | **Integer**| Offset by this many pages, of the size of &#x60;limit&#x60; | [optional] [default to 1]
- **viewer_id** | **String**| Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux. | [optional] 
- **error_id** | **Integer**| Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error. | [optional] 
- **order_direction** | **String**| Sort order. | [optional] 
- **filters** | [**Array&lt;String&gt;**](String.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US).  Possible filter names are the same as returned by the List Filters endpoint.  | [optional] 
- **timeframe** | [**Array&lt;String&gt;**](String.md)| Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are...   * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600    * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Number of items to include in the response | [optional][default to 25] |
+| **page** | **Integer** | Offset by this many pages, of the size of &#x60;limit&#x60; | [optional][default to 1] |
+| **viewer_id** | **String** | Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux. | [optional] |
+| **error_id** | **Integer** | Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error. | [optional] |
+| **order_direction** | **String** | Sort order. | [optional] |
+| **filters** | [**Array&lt;String&gt;**](String.md) | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US). Possible filter names are the same as returned by the List Filters endpoint.  | [optional] |
+| **timeframe** | [**Array&lt;String&gt;**](String.md) | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are...   * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600   * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.  | [optional] |
 
 ### Return type
 
@@ -119,8 +158,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 

data/examples/data/exercise-dimensions.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require 'mux_ruby'
+require 'solid_assert'
+
+SolidAssert.enable_assertions
+
+# Authentication Setup
+openapi = MuxRuby.configure do |config|
+  config.username = ENV['MUX_TOKEN_ID']
+  config.password = ENV['MUX_TOKEN_SECRET']
+end
+
+# API Client Initialization
+dimensions_api = MuxRuby::DimensionsApi.new
+
+# ========== list-dimensions ==========
+dimensions = dimensions_api.list_dimensions()
+assert dimensions != nil
+assert dimensions.data != nil
+assert dimensions.data.basic != nil
+assert dimensions.data.advanced != nil
+puts "list-dimensions OK ✅"
+
+# ========== list-dimension-values ==========
+dimension_values = dimensions_api.list_dimension_values("browser", {:timeframe => ['7:days']})
+assert dimension_values != nil
+assert dimension_values.data != nil
+puts "list-dimension-values OK ✅"

data/examples/data/exercise-incidents.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require 'mux_ruby'
+require 'solid_assert'
+
+SolidAssert.enable_assertions
+
+# Authentication Setup
+openapi = MuxRuby.configure do |config|
+  config.username = ENV['MUX_TOKEN_ID']
+  config.password = ENV['MUX_TOKEN_SECRET']
+end
+
+# API Client Initialization
+incidents_api = MuxRuby::IncidentsApi.new
+
+# Test coverage here is poor due to not knowning if the account we're testing against has any incidents.
+
+# ========== list-incidents ==========
+incidents = incidents_api.list_incidents
+assert incidents != nil
+assert incidents.data != nil
+puts "list-incidents OK ✅"
+
+# ========== get-incident ==========
+puts "get-incident SKIP ⚠️"
+
+# ========== list-related-incidents ==========
+puts "list-related-incidents SKIP ⚠️"

data/examples/data/exercise-realtime.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+require 'mux_ruby'
+require 'solid_assert'
+
+SolidAssert.enable_assertions
+
+# Authentication Setup
+openapi = MuxRuby.configure do |config|
+  config.username = ENV['MUX_TOKEN_ID']
+  config.password = ENV['MUX_TOKEN_SECRET']
+end
+
+# API Client Initialization
+rt_api = MuxRuby::RealTimeApi.new
+
+# Test coverage here isn't fantastic due to not knowning if the account we're testing against has
+# any real-time data. The behaviour has been manually verified against real-world data.
+
+# ========== list-realtime-dimensions ==========
+dimensions = rt_api.list_realtime_dimensions
+assert dimensions != nil
+assert dimensions.data != nil
+assert dimensions.data.length > 0
+assert dimensions.data.first.name != ''
+assert dimensions.data.first.display_name != ''
+puts "list-realtime-dimensions OK ✅"
+
+# ========== list-realtime-metrics ==========
+metrics = rt_api.list_realtime_metrics
+assert metrics != nil
+assert metrics.data != nil
+assert metrics.data.length > 0
+assert metrics.data.first.name != ''
+assert metrics.data.first.display_name != ''
+puts "list-realtime-metrics OK ✅"
+
+# ========== get-realtime-breakdown ==========
+breakdown = rt_api.get_realtime_breakdown('current-rebuffering-percentage', {:dimension => 'asn'})
+assert breakdown != nil
+assert breakdown.data != nil
+puts "get-realtime-breakdown OK ✅"
+
+# ========== get-realtime-histogram-timeseries ==========
+histogram_timeseries = rt_api.get_realtime_histogram_timeseries('video-startup-time')
+assert histogram_timeseries != nil
+assert histogram_timeseries.meta != nil
+assert histogram_timeseries.meta.buckets != nil
+assert histogram_timeseries.meta.buckets.length > 0
+assert histogram_timeseries.data != nil
+assert histogram_timeseries.data.length > 0
+puts "get-realtime-histogram-timeseries OK ✅"
+
+# ========== get-realtime-timeseries ==========
+timeseries = rt_api.get_realtime_timeseries('current-rebuffering-percentage')
+assert timeseries != nil
+assert timeseries.data != nil
+assert timeseries.data.length > 0
+assert timeseries.data.first.date != ''
+puts "get-realtime-timeseries OK ✅"

data/examples/video/exercise-assets.rb

@@ -13,6 +13,7 @@ end
 
 # API Client Initialization
 assets_api = MuxRuby::AssetsApi.new
+playback_ids_api = MuxRuby::PlaybackIDApi.new
 
 # ========== create-asset ==========
 car = MuxRuby::CreateAssetRequest.new
@@ -52,6 +53,20 @@ end
 puts "get-asset OK ✅"
 puts "get-asset-input-info OK ✅"
 
+# ========== clipping ==========
+clip_request = MuxRuby::CreateAssetRequest.new
+clip_request.input = [
+  {
+    url: "mux://assets/#{create_response.data.id}",
+    start_time: 0.0,
+    end_time: 5.0
+  }
+]
+create_clip_response = assets_api.create_asset(clip_request)
+assert create_clip_response != nil
+assert create_clip_response.data.id != nil
+puts "clipping OK ✅"
+
 # ========== create-asset-playback-id ==========
 cpbr = MuxRuby::CreatePlaybackIDRequest.new
 cpbr.policy = MuxRuby::PlaybackPolicy::PUBLIC
@@ -67,6 +82,12 @@ assert pb_id.data != nil
 assert pb_id.data.id == pb_id_c.data.id
 puts "get-asset-playback-id OK ✅"
 
+# ========== get-asset-or-livestream-id ==========
+get_playback_id_resp = playback_ids_api.get_asset_or_livestream_id(pb_id.data.id).data
+assert get_playback_id_resp.object.id == create_response.data.id
+assert get_playback_id_resp.object.type == "asset"
+puts "get-asset-or-livestream-id OK ✅"
+
 # ========== update-asset-mp4-support ==========
 mp4_req = MuxRuby::UpdateAssetMP4SupportRequest.new
 mp4_req.mp4_support = 'standard'

data/examples/video/exercise-live-streams.rb

@@ -13,6 +13,7 @@ end
 
 # API Client Initialization
 live_api = MuxRuby::LiveStreamsApi.new
+playback_ids_api = MuxRuby::PlaybackIDApi.new
 
 # ========== create-live-stream ==========
 create_asset_request = MuxRuby::CreateAssetRequest.new
@@ -41,6 +42,13 @@ assert stream_get.data != nil
 assert stream_get.data.id == stream.data.id
 puts "get-live-stream OK ✅"
 
+# ========== get-asset-or-livestream-id ==========
+playback_id = stream.data.playback_ids.first.id
+get_playback_id_resp = playback_ids_api.get_asset_or_livestream_id(playback_id).data
+assert get_playback_id_resp.object.id == stream.data.id
+assert get_playback_id_resp.object.type == "live_stream"
+puts "get-asset-or-livestream-id OK ✅"
+
 # ========== create-live-stream-simulcast-target ==========
 create_simulcast_target = MuxRuby::CreateSimulcastTargetRequest.new
 create_simulcast_target.passthrough = 'foo'
@@ -104,6 +112,28 @@ rescue MuxRuby::ApiError => e
 end
 puts "signal-live-stream-complete OK ✅"
 
+# ========== disable-live-stream ==========
+begin
+  live_api.disable_live_stream(stream.data.id)
+  disabled_live_stream = live_api.get_live_stream(stream.data.id)
+  assert disabled_live_stream.data.status == 'disabled'
+rescue MuxRuby::ApiError => e
+  puts "Should not have errored when disabling stream"
+  exit 1
+end
+puts "disable-live-stream OK ✅"
+
+# ========== enable-live-stream ==========
+begin
+  live_api.enable_live_stream(stream.data.id)
+  enabled_live_stream = live_api.get_live_stream(stream.data.id)
+  assert enabled_live_stream.data.status == 'idle'
+rescue MuxRuby::ApiError => e
+  puts "Should not have errored when enabling stream"
+  exit 1
+end
+puts "enable-live-stream OK ✅"
+
 # ========== delete-live-stream ==========
 live_api.delete_live_stream(stream.data.id)
 begin