Class: DatadogAPIClient::V2::RumReplayPlaylistsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ RumReplayPlaylistsAPI

Returns a new instance of RumReplayPlaylistsAPI.



22
23
24
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



20
21
22
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#add_rum_replay_session_to_playlist(ts, playlist_id, session_id, opts = {}) ⇒ Object

Add rum replay session to playlist.



29
30
31
32
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 29

def add_rum_replay_session_to_playlist(ts, playlist_id, session_id, opts = {})
  data, _status_code, _headers = add_rum_replay_session_to_playlist_with_http_info(ts, playlist_id, session_id, opts)
  data
end

#add_rum_replay_session_to_playlist_with_http_info(ts, playlist_id, session_id, opts = {}) ⇒ Array<(PlaylistsSession, Integer, Hash)>

Add rum replay session to playlist.

Add a session to a playlist.

Parameters:

  • ts (Integer)

    Server-side timestamp in milliseconds.

  • playlist_id (Integer)

    Unique identifier of the playlist.

  • session_id (String)

    Unique identifier of the session.

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

    the optional parameters

Options Hash (opts):

  • :data_source (String)

    Data source type. Valid values: 'rum' or 'product_analytics'. Defaults to 'rum'.

Returns:

  • (Array<(PlaylistsSession, Integer, Hash)>)

    PlaylistsSession data, response status code and response headers



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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 44

def add_rum_replay_session_to_playlist_with_http_info(ts, playlist_id, session_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayPlaylistsAPI.add_rum_replay_session_to_playlist ...'
  end
  # verify the required parameter 'ts' is set
  if @api_client.config.client_side_validation && ts.nil?
    fail ArgumentError, "Missing the required parameter 'ts' when calling RumReplayPlaylistsAPI.add_rum_replay_session_to_playlist"
  end
  # verify the required parameter 'playlist_id' is set
  if @api_client.config.client_side_validation && playlist_id.nil?
    fail ArgumentError, "Missing the required parameter 'playlist_id' when calling RumReplayPlaylistsAPI.add_rum_replay_session_to_playlist"
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RumReplayPlaylistsAPI.add_rum_replay_session_to_playlist"
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/playlists/{playlist_id}/sessions/{session_id}'.sub('{playlist_id}', CGI.escape(playlist_id.to_s).gsub('%2F', '/')).sub('{session_id}', CGI.escape(session_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ts'] = ts
  query_params[:'data_source'] = opts[:'data_source'] if !opts[:'data_source'].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] || 'PlaylistsSession'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :add_rum_replay_session_to_playlist,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#bulk_remove_rum_replay_playlist_sessions(playlist_id, body, opts = {}) ⇒ Object

Bulk remove rum replay playlist sessions.



107
108
109
110
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 107

def bulk_remove_rum_replay_playlist_sessions(playlist_id, body, opts = {})
  bulk_remove_rum_replay_playlist_sessions_with_http_info(playlist_id, body, opts)
  nil
end

#bulk_remove_rum_replay_playlist_sessions_with_http_info(playlist_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Bulk remove rum replay playlist sessions.

Remove sessions from a playlist.

Parameters:

  • playlist_id (Integer)

    Unique identifier of the playlist.

  • body (SessionIdArray)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
166
167
168
169
170
171
172
173
174
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 120

def bulk_remove_rum_replay_playlist_sessions_with_http_info(playlist_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayPlaylistsAPI.bulk_remove_rum_replay_playlist_sessions ...'
  end
  # verify the required parameter 'playlist_id' is set
  if @api_client.config.client_side_validation && playlist_id.nil?
    fail ArgumentError, "Missing the required parameter 'playlist_id' when calling RumReplayPlaylistsAPI.bulk_remove_rum_replay_playlist_sessions"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling RumReplayPlaylistsAPI.bulk_remove_rum_replay_playlist_sessions"
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/playlists/{playlist_id}/sessions'.sub('{playlist_id}', CGI.escape(playlist_id.to_s).gsub('%2F', '/'))

  # 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(['*/*'])
  # 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(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :bulk_remove_rum_replay_playlist_sessions,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#create_rum_replay_playlist(body, opts = {}) ⇒ Object

Create rum replay playlist.



179
180
181
182
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 179

def create_rum_replay_playlist(body, opts = {})
  data, _status_code, _headers = create_rum_replay_playlist_with_http_info(body, opts)
  data
end

#create_rum_replay_playlist_with_http_info(body, opts = {}) ⇒ Array<(Playlist, Integer, Hash)>

Create rum replay playlist.

Create a playlist.

Parameters:

  • body (Playlist)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Playlist, Integer, Hash)>)

    Playlist data, response status code and response headers



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 191

def create_rum_replay_playlist_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayPlaylistsAPI.create_rum_replay_playlist ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling RumReplayPlaylistsAPI.create_rum_replay_playlist"
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/playlists'

  # 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(body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_rum_replay_playlist,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#delete_rum_replay_playlist(playlist_id, opts = {}) ⇒ Object

Delete rum replay playlist.



246
247
248
249
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 246

def delete_rum_replay_playlist(playlist_id, opts = {})
  delete_rum_replay_playlist_with_http_info(playlist_id, opts)
  nil
end

#delete_rum_replay_playlist_with_http_info(playlist_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete rum replay playlist.

Delete a playlist.

Parameters:

  • playlist_id (Integer)

    Unique identifier of the playlist.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 258

def delete_rum_replay_playlist_with_http_info(playlist_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayPlaylistsAPI.delete_rum_replay_playlist ...'
  end
  # verify the required parameter 'playlist_id' is set
  if @api_client.config.client_side_validation && playlist_id.nil?
    fail ArgumentError, "Missing the required parameter 'playlist_id' when calling RumReplayPlaylistsAPI.delete_rum_replay_playlist"
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/playlists/{playlist_id}'.sub('{playlist_id}', CGI.escape(playlist_id.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

  # 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] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_rum_replay_playlist,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_rum_replay_playlist(playlist_id, opts = {}) ⇒ Object

Get rum replay playlist.



311
312
313
314
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 311

def get_rum_replay_playlist(playlist_id, opts = {})
  data, _status_code, _headers = get_rum_replay_playlist_with_http_info(playlist_id, opts)
  data
end

#get_rum_replay_playlist_with_http_info(playlist_id, opts = {}) ⇒ Array<(Playlist, Integer, Hash)>

Get rum replay playlist.

Get a playlist.

Parameters:

  • playlist_id (Integer)

    Unique identifier of the playlist.

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

    the optional parameters

Returns:

  • (Array<(Playlist, Integer, Hash)>)

    Playlist data, response status code and response headers



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 323

def get_rum_replay_playlist_with_http_info(playlist_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayPlaylistsAPI.get_rum_replay_playlist ...'
  end
  # verify the required parameter 'playlist_id' is set
  if @api_client.config.client_side_validation && playlist_id.nil?
    fail ArgumentError, "Missing the required parameter 'playlist_id' when calling RumReplayPlaylistsAPI.get_rum_replay_playlist"
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/playlists/{playlist_id}'.sub('{playlist_id}', CGI.escape(playlist_id.to_s).gsub('%2F', '/'))

  # 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] || 'Playlist'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_rum_replay_playlist,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#list_rum_replay_playlist_sessions(playlist_id, opts = {}) ⇒ Object

List rum replay playlist sessions.



444
445
446
447
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 444

def list_rum_replay_playlist_sessions(playlist_id, opts = {})
  data, _status_code, _headers = list_rum_replay_playlist_sessions_with_http_info(playlist_id, opts)
  data
end

#list_rum_replay_playlist_sessions_with_http_info(playlist_id, opts = {}) ⇒ Array<(PlaylistsSessionArray, Integer, Hash)>

List rum replay playlist sessions.

List sessions in a playlist.

Parameters:

  • playlist_id (Integer)

    Unique identifier of the playlist.

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)

    Page number for pagination (0-indexed).

  • :page_size (Integer)

    Number of items per page.

Returns:

  • (Array<(PlaylistsSessionArray, Integer, Hash)>)

    PlaylistsSessionArray data, response status code and response headers



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 458

def list_rum_replay_playlist_sessions_with_http_info(playlist_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayPlaylistsAPI.list_rum_replay_playlist_sessions ...'
  end
  # verify the required parameter 'playlist_id' is set
  if @api_client.config.client_side_validation && playlist_id.nil?
    fail ArgumentError, "Missing the required parameter 'playlist_id' when calling RumReplayPlaylistsAPI.list_rum_replay_playlist_sessions"
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/playlists/{playlist_id}/sessions'.sub('{playlist_id}', CGI.escape(playlist_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].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] || 'PlaylistsSessionArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_rum_replay_playlist_sessions,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#list_rum_replay_playlists(opts = {}) ⇒ Object

List rum replay playlists.



376
377
378
379
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 376

def list_rum_replay_playlists(opts = {})
  data, _status_code, _headers = list_rum_replay_playlists_with_http_info(opts)
  data
end

#list_rum_replay_playlists_with_http_info(opts = {}) ⇒ Array<(PlaylistArray, Integer, Hash)>

List rum replay playlists.

List playlists.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_created_by_uuid (String)

    Filter playlists by the UUID of the user who created them.

  • :filter_query (String)

    Search query to filter playlists by name.

  • :page_number (Integer)

    Page number for pagination (0-indexed).

  • :page_size (Integer)

    Number of items per page.

Returns:

  • (Array<(PlaylistArray, Integer, Hash)>)

    PlaylistArray data, response status code and response headers



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 391

def list_rum_replay_playlists_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayPlaylistsAPI.list_rum_replay_playlists ...'
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/playlists'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[created_by_uuid]'] = opts[:'filter_created_by_uuid'] if !opts[:'filter_created_by_uuid'].nil?
  query_params[:'filter[query]'] = opts[:'filter_query'] if !opts[:'filter_query'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].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] || 'PlaylistArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_rum_replay_playlists,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#remove_rum_replay_session_from_playlist(playlist_id, session_id, opts = {}) ⇒ Object

Remove rum replay session from playlist.



513
514
515
516
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 513

def remove_rum_replay_session_from_playlist(playlist_id, session_id, opts = {})
  remove_rum_replay_session_from_playlist_with_http_info(playlist_id, session_id, opts)
  nil
end

#remove_rum_replay_session_from_playlist_with_http_info(playlist_id, session_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove rum replay session from playlist.

Remove a session from a playlist.

Parameters:

  • playlist_id (Integer)

    Unique identifier of the playlist.

  • session_id (String)

    Unique identifier of the session.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 526

def remove_rum_replay_session_from_playlist_with_http_info(playlist_id, session_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayPlaylistsAPI.remove_rum_replay_session_from_playlist ...'
  end
  # verify the required parameter 'playlist_id' is set
  if @api_client.config.client_side_validation && playlist_id.nil?
    fail ArgumentError, "Missing the required parameter 'playlist_id' when calling RumReplayPlaylistsAPI.remove_rum_replay_session_from_playlist"
  end
  # verify the required parameter 'session_id' is set
  if @api_client.config.client_side_validation && session_id.nil?
    fail ArgumentError, "Missing the required parameter 'session_id' when calling RumReplayPlaylistsAPI.remove_rum_replay_session_from_playlist"
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/playlists/{playlist_id}/sessions/{session_id}'.sub('{playlist_id}', CGI.escape(playlist_id.to_s).gsub('%2F', '/')).sub('{session_id}', CGI.escape(session_id.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

  # 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] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :remove_rum_replay_session_from_playlist,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#update_rum_replay_playlist(playlist_id, body, opts = {}) ⇒ Object

Update rum replay playlist.



583
584
585
586
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 583

def update_rum_replay_playlist(playlist_id, body, opts = {})
  data, _status_code, _headers = update_rum_replay_playlist_with_http_info(playlist_id, body, opts)
  data
end

#update_rum_replay_playlist_with_http_info(playlist_id, body, opts = {}) ⇒ Array<(Playlist, Integer, Hash)>

Update rum replay playlist.

Update a playlist.

Parameters:

  • playlist_id (Integer)

    Unique identifier of the playlist.

  • body (Playlist)
  • opts (Hash) (defaults to: {})

    the optional parameters

Returns:

  • (Array<(Playlist, Integer, Hash)>)

    Playlist data, response status code and response headers



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
# File 'lib/datadog_api_client/v2/api/rum_replay_playlists_api.rb', line 596

def update_rum_replay_playlist_with_http_info(playlist_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RumReplayPlaylistsAPI.update_rum_replay_playlist ...'
  end
  # verify the required parameter 'playlist_id' is set
  if @api_client.config.client_side_validation && playlist_id.nil?
    fail ArgumentError, "Missing the required parameter 'playlist_id' when calling RumReplayPlaylistsAPI.update_rum_replay_playlist"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling RumReplayPlaylistsAPI.update_rum_replay_playlist"
  end
  # resource path
  local_var_path = '/api/v2/rum/replay/playlists/{playlist_id}'.sub('{playlist_id}', CGI.escape(playlist_id.to_s).gsub('%2F', '/'))

  # 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(body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_rum_replay_playlist,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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