Class: MuxRuby::VideoViewsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/api/video_views_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VideoViewsApi 



19
20
21
 
# File 'lib/mux_ruby/api/video_views_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mux_ruby/api/video_views_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_video_view(video_view_id, opts = {}) ⇒ VideoViewResponse

Get a Video View Returns the details of a video view.



27
28
29
30
 
# File 'lib/mux_ruby/api/video_views_api.rb', line 27

def get_video_view(video_view_id, opts = {})
  data, _status_code, _headers = get_video_view_with_http_info(video_view_id, opts)
  data
end

#get_video_view_with_http_info(video_view_id, opts = {}) ⇒ Array<(VideoViewResponse, Integer, Hash)>

Get a Video View Returns the details of a video view.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/mux_ruby/api/video_views_api.rb', line 37

def get_video_view_with_http_info(video_view_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VideoViewsApi.get_video_view ...'
  end
  # verify the required parameter 'video_view_id' is set
  if @api_client.config.client_side_validation && video_view_id.nil?
    fail ArgumentError, "Missing the required parameter 'video_view_id' when calling VideoViewsApi.get_video_view"
  end
  # resource path
  local_var_path = '/data/v1/video-views/{VIDEO_VIEW_ID}'.sub('{' + 'VIDEO_VIEW_ID' + '}', CGI.escape(video_view_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'VideoViewResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"VideoViewsApi.get_video_view",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideoViewsApi#get_video_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_video_views(opts = {}) ⇒ ListVideoViewsResponse

List Video Views Returns a list of video views.

Options Hash (opts):

  • :limit (Integer) —

    Number of items to include in the response (default to 25)

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60; (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.

  • :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.

  • :order_direction (String) —

    Sort order.

  • :filters (Array<String>) —

    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.

  • :timeframe (Array<String>) —

    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.



96
97
98
99
 
# File 'lib/mux_ruby/api/video_views_api.rb', line 96

def list_video_views(opts = {})
  data, _status_code, _headers = list_video_views_with_http_info(opts)
  data
end

#list_video_views_with_http_info(opts = {}) ⇒ Array<(ListVideoViewsResponse, Integer, Hash)>

List Video Views Returns a list of video views.

Options Hash (opts):

  • :limit (Integer) —

    Number of items to include in the response

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60;

  • :viewer_id (String) —

    Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux.

  • :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.

  • :order_direction (String) —

    Sort order.

  • :filters (Array<String>) —

    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.

  • :timeframe (Array<String>) —

    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.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/mux_ruby/api/video_views_api.rb', line 112

def list_video_views_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VideoViewsApi.list_video_views ...'
  end
  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
    fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/video-views'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'viewer_id'] = opts[:'viewer_id'] if !opts[:'viewer_id'].nil?
  query_params[:'error_id'] = opts[:'error_id'] if !opts[:'error_id'].nil?
  query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].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 = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListVideoViewsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"VideoViewsApi.list_video_views",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideoViewsApi#list_video_views\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end