Class: MuxRuby::PlaybackRestrictionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PlaybackRestrictionsApi

Returns a new instance of PlaybackRestrictionsApi.



19
20
21
 
# File 'lib/mux_ruby/api/playback_restrictions_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/playback_restrictions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_playback_restriction(create_playback_restriction_request, opts = {}) ⇒ PlaybackRestrictionResponse

Create a Playback Restriction Create a new Playback Restriction.

Parameters:

Returns:



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

def create_playback_restriction(create_playback_restriction_request, opts = {})
  data, _status_code, _headers = create_playback_restriction_with_http_info(create_playback_restriction_request, opts)
  data
end

#create_playback_restriction_with_http_info(create_playback_restriction_request, opts = {}) ⇒ Array<(PlaybackRestrictionResponse, Integer, Hash)>

Create a Playback Restriction Create a new Playback Restriction.

Parameters:

Returns:

  • (Array<(PlaybackRestrictionResponse, Integer, Hash)>) —

    PlaybackRestrictionResponse data, response status code and response headers



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
84
85
 
# File 'lib/mux_ruby/api/playback_restrictions_api.rb', line 37

def create_playback_restriction_with_http_info(create_playback_restriction_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.create_playback_restriction ...'
  end
  # verify the required parameter 'create_playback_restriction_request' is set
  if @api_client.config.client_side_validation && create_playback_restriction_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_playback_restriction_request' when calling PlaybackRestrictionsApi.create_playback_restriction"
  end
  # resource path
  local_var_path = '/video/v1/playback-restrictions'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_playback_restriction_request)

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

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

  new_options = opts.merge(
    :operation => :"PlaybackRestrictionsApi.create_playback_restriction",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaybackRestrictionsApi#create_playback_restriction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_playback_restriction(playback_restriction_id, opts = {}) ⇒ nil

Delete a Playback Restriction Deletes a single Playback Restriction.

Parameters:

  • playback_restriction_id (String) —

    ID of the Playback Restriction.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


92
93
94
95
 
# File 'lib/mux_ruby/api/playback_restrictions_api.rb', line 92

def delete_playback_restriction(playback_restriction_id, opts = {})
  delete_playback_restriction_with_http_info(playback_restriction_id, opts)
  nil
end

#delete_playback_restriction_with_http_info(playback_restriction_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a Playback Restriction Deletes a single Playback Restriction.

Parameters:

  • playback_restriction_id (String) —

    ID of the Playback Restriction.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



102
103
104
105
106
107
108
109
110
111
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
 
# File 'lib/mux_ruby/api/playback_restrictions_api.rb', line 102

def delete_playback_restriction_with_http_info(playback_restriction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.delete_playback_restriction ...'
  end
  # verify the required parameter 'playback_restriction_id' is set
  if @api_client.config.client_side_validation && playback_restriction_id.nil?
    fail ArgumentError, "Missing the required parameter 'playback_restriction_id' when calling PlaybackRestrictionsApi.delete_playback_restriction"
  end
  # resource path
  local_var_path = '/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}'.sub('{' + 'PLAYBACK_RESTRICTION_ID' + '}', CGI.escape(playback_restriction_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"PlaybackRestrictionsApi.delete_playback_restriction",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaybackRestrictionsApi#delete_playback_restriction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_playback_restriction(playback_restriction_id, opts = {}) ⇒ PlaybackRestrictionResponse

Retrieve a Playback Restriction Retrieves a Playback Restriction associated with the unique identifier.

Parameters:

  • playback_restriction_id (String) —

    ID of the Playback Restriction.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



153
154
155
156
 
# File 'lib/mux_ruby/api/playback_restrictions_api.rb', line 153

def get_playback_restriction(playback_restriction_id, opts = {})
  data, _status_code, _headers = get_playback_restriction_with_http_info(playback_restriction_id, opts)
  data
end

#get_playback_restriction_with_http_info(playback_restriction_id, opts = {}) ⇒ Array<(PlaybackRestrictionResponse, Integer, Hash)>

Retrieve a Playback Restriction Retrieves a Playback Restriction associated with the unique identifier.

Parameters:

  • playback_restriction_id (String) —

    ID of the Playback Restriction.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PlaybackRestrictionResponse, Integer, Hash)>) —

    PlaybackRestrictionResponse data, response status code and response headers



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/mux_ruby/api/playback_restrictions_api.rb', line 163

def get_playback_restriction_with_http_info(playback_restriction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.get_playback_restriction ...'
  end
  # verify the required parameter 'playback_restriction_id' is set
  if @api_client.config.client_side_validation && playback_restriction_id.nil?
    fail ArgumentError, "Missing the required parameter 'playback_restriction_id' when calling PlaybackRestrictionsApi.get_playback_restriction"
  end
  # resource path
  local_var_path = '/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}'.sub('{' + 'PLAYBACK_RESTRICTION_ID' + '}', CGI.escape(playback_restriction_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] || 'PlaybackRestrictionResponse'

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

  new_options = opts.merge(
    :operation => :"PlaybackRestrictionsApi.get_playback_restriction",
    :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: PlaybackRestrictionsApi#get_playback_restriction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_playback_restrictions(opts = {}) ⇒ ListPlaybackRestrictionsResponse

List Playback Restrictions Returns a list of all Playback Restrictions.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)

  • :limit (Integer) —

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

Returns:



217
218
219
220
 
# File 'lib/mux_ruby/api/playback_restrictions_api.rb', line 217

def list_playback_restrictions(opts = {})
  data, _status_code, _headers = list_playback_restrictions_with_http_info(opts)
  data
end

#list_playback_restrictions_with_http_info(opts = {}) ⇒ Array<(ListPlaybackRestrictionsResponse, Integer, Hash)>

List Playback Restrictions Returns a list of all Playback Restrictions.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

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

  • :limit (Integer) —

    Number of items to include in the response

Returns:



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/mux_ruby/api/playback_restrictions_api.rb', line 228

def list_playback_restrictions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.list_playback_restrictions ...'
  end
  # resource path
  local_var_path = '/video/v1/playback-restrictions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'ListPlaybackRestrictionsResponse'

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

  new_options = opts.merge(
    :operation => :"PlaybackRestrictionsApi.list_playback_restrictions",
    :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: PlaybackRestrictionsApi#list_playback_restrictions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_referrer_domain_restriction(playback_restriction_id, update_referrer_domain_restriction_request, opts = {}) ⇒ PlaybackRestrictionResponse

Update the Referrer Playback Restriction Allows you to modify the list of domains or change how Mux validates playback requests without the ‘Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.

Parameters:

  • playback_restriction_id (String) —

    ID of the Playback Restriction.

  • update_referrer_domain_restriction_request (UpdateReferrerDomainRestrictionRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



280
281
282
283
 
# File 'lib/mux_ruby/api/playback_restrictions_api.rb', line 280

def update_referrer_domain_restriction(playback_restriction_id, update_referrer_domain_restriction_request, opts = {})
  data, _status_code, _headers = update_referrer_domain_restriction_with_http_info(playback_restriction_id, update_referrer_domain_restriction_request, opts)
  data
end

#update_referrer_domain_restriction_with_http_info(playback_restriction_id, update_referrer_domain_restriction_request, opts = {}) ⇒ Array<(PlaybackRestrictionResponse, Integer, Hash)>

Update the Referrer Playback Restriction Allows you to modify the list of domains or change how Mux validates playback requests without the &#x60;Referer&#x60; HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.

Parameters:

  • playback_restriction_id (String) —

    ID of the Playback Restriction.

  • update_referrer_domain_restriction_request (UpdateReferrerDomainRestrictionRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PlaybackRestrictionResponse, Integer, Hash)>) —

    PlaybackRestrictionResponse data, response status code and response headers



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/mux_ruby/api/playback_restrictions_api.rb', line 291

def update_referrer_domain_restriction_with_http_info(playback_restriction_id, update_referrer_domain_restriction_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.update_referrer_domain_restriction ...'
  end
  # verify the required parameter 'playback_restriction_id' is set
  if @api_client.config.client_side_validation && playback_restriction_id.nil?
    fail ArgumentError, "Missing the required parameter 'playback_restriction_id' when calling PlaybackRestrictionsApi.update_referrer_domain_restriction"
  end
  # verify the required parameter 'update_referrer_domain_restriction_request' is set
  if @api_client.config.client_side_validation && update_referrer_domain_restriction_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_referrer_domain_restriction_request' when calling PlaybackRestrictionsApi.update_referrer_domain_restriction"
  end
  # resource path
  local_var_path = '/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer'.sub('{' + 'PLAYBACK_RESTRICTION_ID' + '}', CGI.escape(playback_restriction_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_referrer_domain_restriction_request)

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

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

  new_options = opts.merge(
    :operation => :"PlaybackRestrictionsApi.update_referrer_domain_restriction",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaybackRestrictionsApi#update_referrer_domain_restriction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request, opts = {}) ⇒ PlaybackRestrictionResponse

Update the User Agent Restriction Allows you to modify how Mux validates playback requests with different user agents. Please see [Using User-Agent HTTP header for validation](docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.

Parameters:

  • playback_restriction_id (String) —

    ID of the Playback Restriction.

  • update_user_agent_restriction_request (UpdateUserAgentRestrictionRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



351
352
353
354
 
# File 'lib/mux_ruby/api/playback_restrictions_api.rb', line 351

def update_user_agent_restriction(playback_restriction_id, update_user_agent_restriction_request, opts = {})
  data, _status_code, _headers = update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request, opts)
  data
end

#update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request, opts = {}) ⇒ Array<(PlaybackRestrictionResponse, Integer, Hash)>

Update the User Agent Restriction Allows you to modify how Mux validates playback requests with different user agents. Please see [Using User-Agent HTTP header for validation](docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature.

Parameters:

  • playback_restriction_id (String) —

    ID of the Playback Restriction.

  • update_user_agent_restriction_request (UpdateUserAgentRestrictionRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PlaybackRestrictionResponse, Integer, Hash)>) —

    PlaybackRestrictionResponse data, response status code and response headers



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/mux_ruby/api/playback_restrictions_api.rb', line 362

def update_user_agent_restriction_with_http_info(playback_restriction_id, update_user_agent_restriction_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlaybackRestrictionsApi.update_user_agent_restriction ...'
  end
  # verify the required parameter 'playback_restriction_id' is set
  if @api_client.config.client_side_validation && playback_restriction_id.nil?
    fail ArgumentError, "Missing the required parameter 'playback_restriction_id' when calling PlaybackRestrictionsApi.update_user_agent_restriction"
  end
  # verify the required parameter 'update_user_agent_restriction_request' is set
  if @api_client.config.client_side_validation && update_user_agent_restriction_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_user_agent_restriction_request' when calling PlaybackRestrictionsApi.update_user_agent_restriction"
  end
  # resource path
  local_var_path = '/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/user_agent'.sub('{' + 'PLAYBACK_RESTRICTION_ID' + '}', CGI.escape(playback_restriction_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_user_agent_restriction_request)

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

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

  new_options = opts.merge(
    :operation => :"PlaybackRestrictionsApi.update_user_agent_restriction",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PlaybackRestrictionsApi#update_user_agent_restriction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end