mux_ruby 1.4.0 → 1.8.1

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-errors.rb

@@ -15,7 +15,7 @@ end
 errors_api = MuxRuby::ErrorsApi.new
 
 # ========== list-errors ==========
-errors = errors_api.list_errors(:filters => ['browser:Chrome'], :timeframe => ['7:days'])
+errors = errors_api.list_errors(:filters => ['browser:Safari'], :timeframe => ['7:days'])
 assert errors != nil
 assert errors.data != nil
 assert errors.data.length > 0

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-live-streams.rb

@@ -104,6 +104,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

data/lib/mux_ruby.rb

@@ -14,6 +14,8 @@ require 'mux_ruby/models/abridged_video_view'
 require 'mux_ruby/models/asset'
 require 'mux_ruby/models/asset_errors'
 require 'mux_ruby/models/asset_master'
+require 'mux_ruby/models/asset_non_standard_input_reasons'
+require 'mux_ruby/models/asset_recording_times'
 require 'mux_ruby/models/asset_response'
 require 'mux_ruby/models/asset_static_renditions'
 require 'mux_ruby/models/asset_static_renditions_files'
@@ -27,12 +29,24 @@ require 'mux_ruby/models/create_track_request'
 require 'mux_ruby/models/create_track_response'
 require 'mux_ruby/models/create_upload_request'
 require 'mux_ruby/models/delivery_report'
+require 'mux_ruby/models/dimension_value'
+require 'mux_ruby/models/disable_live_stream_response'
+require 'mux_ruby/models/enable_live_stream_response'
 require 'mux_ruby/models/error'
 require 'mux_ruby/models/filter_value'
 require 'mux_ruby/models/get_asset_input_info_response'
 require 'mux_ruby/models/get_asset_playback_id_response'
 require 'mux_ruby/models/get_metric_timeseries_data_response'
 require 'mux_ruby/models/get_overall_values_response'
+require 'mux_ruby/models/get_real_time_breakdown_response'
+require 'mux_ruby/models/get_real_time_histogram_timeseries_response'
+require 'mux_ruby/models/get_real_time_histogram_timeseries_response_meta'
+require 'mux_ruby/models/get_real_time_timeseries_response'
+require 'mux_ruby/models/incident'
+require 'mux_ruby/models/incident_breakdown'
+require 'mux_ruby/models/incident_notification'
+require 'mux_ruby/models/incident_notification_rule'
+require 'mux_ruby/models/incident_response'
 require 'mux_ruby/models/input_file'
 require 'mux_ruby/models/input_info'
 require 'mux_ruby/models/input_settings'
@@ -43,22 +57,35 @@ require 'mux_ruby/models/list_all_metric_values_response'
 require 'mux_ruby/models/list_assets_response'
 require 'mux_ruby/models/list_breakdown_values_response'
 require 'mux_ruby/models/list_delivery_usage_response'
+require 'mux_ruby/models/list_dimension_values_response'
+require 'mux_ruby/models/list_dimensions_response'
 require 'mux_ruby/models/list_errors_response'
 require 'mux_ruby/models/list_exports_response'
 require 'mux_ruby/models/list_filter_values_response'
 require 'mux_ruby/models/list_filters_response'
 require 'mux_ruby/models/list_filters_response_data'
+require 'mux_ruby/models/list_incidents_response'
 require 'mux_ruby/models/list_insights_response'
 require 'mux_ruby/models/list_live_streams_response'
+require 'mux_ruby/models/list_real_time_dimensions_response'
+require 'mux_ruby/models/list_real_time_dimensions_response_data'
+require 'mux_ruby/models/list_real_time_metrics_response'
+require 'mux_ruby/models/list_related_incidents_response'
 require 'mux_ruby/models/list_signing_keys_response'
 require 'mux_ruby/models/list_uploads_response'
 require 'mux_ruby/models/list_video_views_response'
 require 'mux_ruby/models/live_stream'
 require 'mux_ruby/models/live_stream_response'
 require 'mux_ruby/models/metric'
+require 'mux_ruby/models/notification_rule'
 require 'mux_ruby/models/overall_values'
 require 'mux_ruby/models/playback_id'
 require 'mux_ruby/models/playback_policy'
+require 'mux_ruby/models/real_time_breakdown_value'
+require 'mux_ruby/models/real_time_histogram_timeseries_bucket'
+require 'mux_ruby/models/real_time_histogram_timeseries_bucket_values'
+require 'mux_ruby/models/real_time_histogram_timeseries_datapoint'
+require 'mux_ruby/models/real_time_timeseries_datapoint'
 require 'mux_ruby/models/score'
 require 'mux_ruby/models/signal_live_stream_complete_response'
 require 'mux_ruby/models/signing_key'
@@ -78,12 +105,15 @@ require 'mux_ruby/models/video_view_response'
 # APIs
 require 'mux_ruby/api/assets_api'
 require 'mux_ruby/api/delivery_usage_api'
+require 'mux_ruby/api/dimensions_api'
 require 'mux_ruby/api/direct_uploads_api'
 require 'mux_ruby/api/errors_api'
 require 'mux_ruby/api/exports_api'
 require 'mux_ruby/api/filters_api'
+require 'mux_ruby/api/incidents_api'
 require 'mux_ruby/api/live_streams_api'
 require 'mux_ruby/api/metrics_api'
+require 'mux_ruby/api/real_time_api'
 require 'mux_ruby/api/url_signing_keys_api'
 require 'mux_ruby/api/video_views_api'
 

data/lib/mux_ruby/api/dimensions_api.rb

@@ -0,0 +1,128 @@
+=begin
+# Mux Ruby - Copyright 2019 Mux Inc.
+# NOTE: This file is auto generated. Do not edit this file manually.
+=end
+
+require 'uri'
+
+module MuxRuby
+  class DimensionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Lists the values for a specific dimension
+    # Lists the values for a dimension along with a total count of related views.   Note: This API replaces the list-filter-values API call. 
+    # @param dimension_id ID of the Dimension
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of items to include in the response (default to 25)
+    # @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
+    # @option opts [Array<String>] :filters 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. 
+    # @option opts [Array<String>] :timeframe 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. 
+    # @return [ListDimensionValuesResponse]
+    def list_dimension_values(dimension_id, opts = {})
+      data, _status_code, _headers = list_dimension_values_with_http_info(dimension_id, opts)
+      data
+    end
+
+    # Lists the values for a specific dimension
+    # Lists the values for a dimension along with a total count of related views.   Note: This API replaces the list-filter-values API call. 
+    # @param dimension_id ID of the Dimension
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of items to include in the response
+    # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
+    # @option opts [Array<String>] :filters 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. 
+    # @option opts [Array<String>] :timeframe 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. 
+    # @return [Array<(ListDimensionValuesResponse, Fixnum, Hash)>] ListDimensionValuesResponse data, response status code and response headers
+    def list_dimension_values_with_http_info(dimension_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DimensionsApi.list_dimension_values ...'
+      end
+      # verify the required parameter 'dimension_id' is set
+      if @api_client.config.client_side_validation && dimension_id.nil?
+        fail ArgumentError, "Missing the required parameter 'dimension_id' when calling DimensionsApi.list_dimension_values"
+      end
+      # resource path
+      local_var_path = '/data/v1/dimensions/{DIMENSION_ID}'.sub('{' + 'DIMENSION_ID' + '}', dimension_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
+      query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['accessToken']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ListDimensionValuesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DimensionsApi#list_dimension_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Dimensions
+    # List all available dimensions.  Note: This API replaces the list-filters API call. 
+    # @param [Hash] opts the optional parameters
+    # @return [ListDimensionsResponse]
+    def list_dimensions(opts = {})
+      data, _status_code, _headers = list_dimensions_with_http_info(opts)
+      data
+    end
+
+    # List Dimensions
+    # List all available dimensions.  Note: This API replaces the list-filters API call. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListDimensionsResponse, Fixnum, Hash)>] ListDimensionsResponse data, response status code and response headers
+    def list_dimensions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DimensionsApi.list_dimensions ...'
+      end
+      # resource path
+      local_var_path = '/data/v1/dimensions'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['accessToken']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ListDimensionsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DimensionsApi#list_dimensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+  end
+end

data/lib/mux_ruby/api/filters_api.rb

@@ -13,7 +13,7 @@ module MuxRuby
       @api_client = api_client
     end
     # Lists values for a specific filter
-    # Lists the values for a filter along with a total count of related views 
+    # Deprecated: The API has been replaced by the list-dimension-values API call.  Lists the values for a filter along with a total count of related views. 
     # @param filter_id ID of the Filter
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of items to include in the response (default to 25)
@@ -27,7 +27,7 @@ module MuxRuby
     end
 
     # Lists values for a specific filter
-    # Lists the values for a filter along with a total count of related views 
+    # Deprecated: The API has been replaced by the list-dimension-values API call.  Lists the values for a filter along with a total count of related views. 
     # @param filter_id ID of the Filter
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of items to include in the response
@@ -78,7 +78,7 @@ module MuxRuby
     end
 
     # List Filters
-    # Lists all the filters broken out into basic and advanced 
+    # Deprecated: The API has been replaced by the list-dimensions API call.  Lists all the filters broken out into basic and advanced. 
     # @param [Hash] opts the optional parameters
     # @return [ListFiltersResponse]
     def list_filters(opts = {})
@@ -87,7 +87,7 @@ module MuxRuby
     end
 
     # List Filters
-    # Lists all the filters broken out into basic and advanced 
+    # Deprecated: The API has been replaced by the list-dimensions API call.  Lists all the filters broken out into basic and advanced. 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ListFiltersResponse, Fixnum, Hash)>] ListFiltersResponse data, response status code and response headers
     def list_filters_with_http_info(opts = {})

data/lib/mux_ruby/api/incidents_api.rb

@@ -0,0 +1,217 @@
+=begin
+# Mux Ruby - Copyright 2019 Mux Inc.
+# NOTE: This file is auto generated. Do not edit this file manually.
+=end
+
+require 'uri'
+
+module MuxRuby
+  class IncidentsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get an Incident
+    # Returns the details of an incident 
+    # @param incident_id ID of the Incident
+    # @param [Hash] opts the optional parameters
+    # @return [IncidentResponse]
+    def get_incident(incident_id, opts = {})
+      data, _status_code, _headers = get_incident_with_http_info(incident_id, opts)
+      data
+    end
+
+    # Get an Incident
+    # Returns the details of an incident 
+    # @param incident_id ID of the Incident
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IncidentResponse, Fixnum, Hash)>] IncidentResponse data, response status code and response headers
+    def get_incident_with_http_info(incident_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncidentsApi.get_incident ...'
+      end
+      # verify the required parameter 'incident_id' is set
+      if @api_client.config.client_side_validation && incident_id.nil?
+        fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsApi.get_incident"
+      end
+      # resource path
+      local_var_path = '/data/v1/incidents/{INCIDENT_ID}'.sub('{' + 'INCIDENT_ID' + '}', incident_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['accessToken']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'IncidentResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IncidentsApi#get_incident\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Incidents
+    # Returns a list of incidents 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of items to include in the response (default to 25)
+    # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
+    # @option opts [String] :order_by Value to order the results by
+    # @option opts [String] :order_direction Sort order.
+    # @option opts [String] :status Status to filter incidents by
+    # @option opts [String] :severity Severity to filter incidents by
+    # @return [ListIncidentsResponse]
+    def list_incidents(opts = {})
+      data, _status_code, _headers = list_incidents_with_http_info(opts)
+      data
+    end
+
+    # List Incidents
+    # Returns a list of incidents 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of items to include in the response
+    # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
+    # @option opts [String] :order_by Value to order the results by
+    # @option opts [String] :order_direction Sort order.
+    # @option opts [String] :status Status to filter incidents by
+    # @option opts [String] :severity Severity to filter incidents by
+    # @return [Array<(ListIncidentsResponse, Fixnum, Hash)>] ListIncidentsResponse data, response status code and response headers
+    def list_incidents_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncidentsApi.list_incidents ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'order_by'] && !['negative_impact', 'value', 'views', 'field'].include?(opts[:'order_by'])
+        fail ArgumentError, 'invalid value for "order_by", must be one of negative_impact, value, views, field'
+      end
+      if @api_client.config.client_side_validation && opts[:'order_direction'] && !['asc', 'desc'].include?(opts[:'order_direction'])
+        fail ArgumentError, 'invalid value for "order_direction", must be one of asc, desc'
+      end
+      if @api_client.config.client_side_validation && opts[:'status'] && !['open', 'closed', 'expired'].include?(opts[:'status'])
+        fail ArgumentError, 'invalid value for "status", must be one of open, closed, expired'
+      end
+      if @api_client.config.client_side_validation && opts[:'severity'] && !['warning', 'alert'].include?(opts[:'severity'])
+        fail ArgumentError, 'invalid value for "severity", must be one of warning, alert'
+      end
+      # resource path
+      local_var_path = '/data/v1/incidents'
+
+      # query parameters
+      query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
+      query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'severity'] = opts[:'severity'] if !opts[:'severity'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['accessToken']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ListIncidentsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IncidentsApi#list_incidents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Related Incidents
+    # Returns all the incidents that seem related to a specific incident 
+    # @param incident_id ID of the Incident
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of items to include in the response (default to 25)
+    # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)
+    # @option opts [String] :order_by Value to order the results by
+    # @option opts [String] :order_direction Sort order.
+    # @return [ListRelatedIncidentsResponse]
+    def list_related_incidents(incident_id, opts = {})
+      data, _status_code, _headers = list_related_incidents_with_http_info(incident_id, opts)
+      data
+    end
+
+    # List Related Incidents
+    # Returns all the incidents that seem related to a specific incident 
+    # @param incident_id ID of the Incident
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of items to include in the response
+    # @option opts [Integer] :page Offset by this many pages, of the size of &#x60;limit&#x60;
+    # @option opts [String] :order_by Value to order the results by
+    # @option opts [String] :order_direction Sort order.
+    # @return [Array<(ListRelatedIncidentsResponse, Fixnum, Hash)>] ListRelatedIncidentsResponse data, response status code and response headers
+    def list_related_incidents_with_http_info(incident_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncidentsApi.list_related_incidents ...'
+      end
+      # verify the required parameter 'incident_id' is set
+      if @api_client.config.client_side_validation && incident_id.nil?
+        fail ArgumentError, "Missing the required parameter 'incident_id' when calling IncidentsApi.list_related_incidents"
+      end
+      if @api_client.config.client_side_validation && opts[:'order_by'] && !['negative_impact', 'value', 'views', 'field'].include?(opts[:'order_by'])
+        fail ArgumentError, 'invalid value for "order_by", must be one of negative_impact, value, views, field'
+      end
+      if @api_client.config.client_side_validation && opts[:'order_direction'] && !['asc', 'desc'].include?(opts[:'order_direction'])
+        fail ArgumentError, 'invalid value for "order_direction", must be one of asc, desc'
+      end
+      # resource path
+      local_var_path = '/data/v1/incidents/{INCIDENT_ID}/related'.sub('{' + 'INCIDENT_ID' + '}', incident_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
+      query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['accessToken']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ListRelatedIncidentsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IncidentsApi#list_related_incidents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+  end
+end