Class: Late::ToolsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/late-sdk/api/tools_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ToolsApi

Returns a new instance of ToolsApi.



19
20
21
 
# File 'lib/late-sdk/api/tools_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/late-sdk/api/tools_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#check_instagram_hashtags(check_instagram_hashtags_request, opts = {}) ⇒ CheckInstagramHashtags200Response

Check IG hashtag bans Check if Instagram hashtags are banned, restricted, or safe to use. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

Returns:



27
28
29
30
 
# File 'lib/late-sdk/api/tools_api.rb', line 27

def check_instagram_hashtags(check_instagram_hashtags_request, opts = {})
  data, _status_code, _headers = check_instagram_hashtags_with_http_info(check_instagram_hashtags_request, opts)
  data
end

#check_instagram_hashtags_with_http_info(check_instagram_hashtags_request, opts = {}) ⇒ Array<(CheckInstagramHashtags200Response, Integer, Hash)>

Check IG hashtag bans Check if Instagram hashtags are banned, restricted, or safe to use. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

Returns:



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
86
87
88
 
# File 'lib/late-sdk/api/tools_api.rb', line 37

def check_instagram_hashtags_with_http_info(check_instagram_hashtags_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsApi.check_instagram_hashtags ...'
  end
  # verify the required parameter 'check_instagram_hashtags_request' is set
  if @api_client.config.client_side_validation && check_instagram_hashtags_request.nil?
    fail ArgumentError, "Missing the required parameter 'check_instagram_hashtags_request' when calling ToolsApi.check_instagram_hashtags"
  end
  # resource path
  local_var_path = '/v1/tools/instagram/hashtag-checker'

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

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

#download_bluesky_media(url, opts = {}) ⇒ DownloadBlueskyMedia200Response

Download Bluesky media Download videos from Bluesky posts. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    Bluesky post URL

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/late-sdk/api/tools_api.rb', line 95

def download_bluesky_media(url, opts = {})
  data, _status_code, _headers = download_bluesky_media_with_http_info(url, opts)
  data
end

#download_bluesky_media_with_http_info(url, opts = {}) ⇒ Array<(DownloadBlueskyMedia200Response, Integer, Hash)>

Download Bluesky media Download videos from Bluesky posts. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    Bluesky post URL

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

    the optional parameters

Returns:



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
147
148
149
150
151
152
 
# File 'lib/late-sdk/api/tools_api.rb', line 105

def download_bluesky_media_with_http_info(url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsApi.download_bluesky_media ...'
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling ToolsApi.download_bluesky_media"
  end
  # resource path
  local_var_path = '/v1/tools/bluesky/download'

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

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

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

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

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

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

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

#download_facebook_video(url, opts = {}) ⇒ DownloadFacebookVideo200Response

Download Facebook video Download videos and reels from Facebook. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    Facebook video or reel URL

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

    the optional parameters

Returns:



159
160
161
162
 
# File 'lib/late-sdk/api/tools_api.rb', line 159

def download_facebook_video(url, opts = {})
  data, _status_code, _headers = download_facebook_video_with_http_info(url, opts)
  data
end

#download_facebook_video_with_http_info(url, opts = {}) ⇒ Array<(DownloadFacebookVideo200Response, Integer, Hash)>

Download Facebook video Download videos and reels from Facebook. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    Facebook video or reel URL

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

    the optional parameters

Returns:



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
210
211
212
213
214
215
216
 
# File 'lib/late-sdk/api/tools_api.rb', line 169

def download_facebook_video_with_http_info(url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsApi.download_facebook_video ...'
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling ToolsApi.download_facebook_video"
  end
  # resource path
  local_var_path = '/v1/tools/facebook/download'

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

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

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

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

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

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

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

#download_instagram_media(url, opts = {}) ⇒ DownloadInstagramMedia200Response

Download Instagram media Download Instagram reels, posts, or photos. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    Instagram reel or post URL

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

    the optional parameters

Returns:



223
224
225
226
 
# File 'lib/late-sdk/api/tools_api.rb', line 223

def download_instagram_media(url, opts = {})
  data, _status_code, _headers = download_instagram_media_with_http_info(url, opts)
  data
end

#download_instagram_media_with_http_info(url, opts = {}) ⇒ Array<(DownloadInstagramMedia200Response, Integer, Hash)>

Download Instagram media Download Instagram reels, posts, or photos. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    Instagram reel or post URL

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

    the optional parameters

Returns:



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
273
274
275
276
277
278
279
280
 
# File 'lib/late-sdk/api/tools_api.rb', line 233

def download_instagram_media_with_http_info(url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsApi.download_instagram_media ...'
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling ToolsApi.download_instagram_media"
  end
  # resource path
  local_var_path = '/v1/tools/instagram/download'

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

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

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

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

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

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

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

#download_linked_in_video(url, opts = {}) ⇒ DownloadInstagramMedia200Response

Download LinkedIn video Download videos from LinkedIn posts. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    LinkedIn post URL

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

    the optional parameters

Returns:



287
288
289
290
 
# File 'lib/late-sdk/api/tools_api.rb', line 287

def download_linked_in_video(url, opts = {})
  data, _status_code, _headers = download_linked_in_video_with_http_info(url, opts)
  data
end

#download_linked_in_video_with_http_info(url, opts = {}) ⇒ Array<(DownloadInstagramMedia200Response, Integer, Hash)>

Download LinkedIn video Download videos from LinkedIn posts. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    LinkedIn post URL

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

    the optional parameters

Returns:



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
344
 
# File 'lib/late-sdk/api/tools_api.rb', line 297

def download_linked_in_video_with_http_info(url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsApi.download_linked_in_video ...'
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling ToolsApi.download_linked_in_video"
  end
  # resource path
  local_var_path = '/v1/tools/linkedin/download'

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

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

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

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

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

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

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

#download_tik_tok_video(url, opts = {}) ⇒ DownloadTikTokVideo200Response

Download TikTok video Download TikTok videos with or without watermark. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    TikTok video URL or ID

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    &#39;formats&#39; to list available formats (default to ‘download’)

  • :format_id (String) —

    Specific format ID (0 &#x3D; no watermark, etc.)

Returns:



353
354
355
356
 
# File 'lib/late-sdk/api/tools_api.rb', line 353

def download_tik_tok_video(url, opts = {})
  data, _status_code, _headers = download_tik_tok_video_with_http_info(url, opts)
  data
end

#download_tik_tok_video_with_http_info(url, opts = {}) ⇒ Array<(DownloadTikTokVideo200Response, Integer, Hash)>

Download TikTok video Download TikTok videos with or without watermark. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    TikTok video URL or ID

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    &#39;formats&#39; to list available formats (default to ‘download’)

  • :format_id (String) —

    Specific format ID (0 &#x3D; no watermark, etc.)

Returns:



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
415
416
417
418
 
# File 'lib/late-sdk/api/tools_api.rb', line 365

def download_tik_tok_video_with_http_info(url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsApi.download_tik_tok_video ...'
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling ToolsApi.download_tik_tok_video"
  end
  allowable_values = ["download", "formats"]
  if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
    fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/tools/tiktok/download'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'url'] = url
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'formatId'] = opts[:'format_id'] if !opts[:'format_id'].nil?

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

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

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

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

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

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

#download_twitter_media(url, opts = {}) ⇒ DownloadInstagramMedia200Response

Download Twitter/X media Download videos from Twitter/X posts. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    Twitter/X post URL

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

    the optional parameters

Options Hash (opts):

  • :action (String) — default: default to 'download'
  • :format_id (String)

Returns:



427
428
429
430
 
# File 'lib/late-sdk/api/tools_api.rb', line 427

def download_twitter_media(url, opts = {})
  data, _status_code, _headers = download_twitter_media_with_http_info(url, opts)
  data
end

#download_twitter_media_with_http_info(url, opts = {}) ⇒ Array<(DownloadInstagramMedia200Response, Integer, Hash)>

Download Twitter/X media Download videos from Twitter/X posts. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    Twitter/X post URL

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

    the optional parameters

Options Hash (opts):

  • :action (String) — default: default to 'download'
  • :format_id (String)

Returns:



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
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
 
# File 'lib/late-sdk/api/tools_api.rb', line 439

def download_twitter_media_with_http_info(url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsApi.download_twitter_media ...'
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling ToolsApi.download_twitter_media"
  end
  allowable_values = ["download", "formats"]
  if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
    fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/tools/twitter/download'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'url'] = url
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'formatId'] = opts[:'format_id'] if !opts[:'format_id'].nil?

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

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

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

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

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

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

#download_you_tube_video(url, opts = {}) ⇒ DownloadYouTubeVideo200Response

Download YouTube video Download YouTube videos or audio. Returns available formats or direct download URL. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    YouTube video URL or video ID

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    Action to perform: &#39;download&#39; returns download URL, &#39;formats&#39; lists available formats (default to ‘download’)

  • :format (String) —

    Desired format (when action&#x3D;download) (default to ‘video’)

  • :quality (String) —

    Desired quality (when action&#x3D;download) (default to ‘hd’)

  • :format_id (String) —

    Specific format ID from formats list

Returns:



503
504
505
506
 
# File 'lib/late-sdk/api/tools_api.rb', line 503

def download_you_tube_video(url, opts = {})
  data, _status_code, _headers = download_you_tube_video_with_http_info(url, opts)
  data
end

#download_you_tube_video_with_http_info(url, opts = {}) ⇒ Array<(DownloadYouTubeVideo200Response, Integer, Hash)>

Download YouTube video Download YouTube videos or audio. Returns available formats or direct download URL. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    YouTube video URL or video ID

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    Action to perform: &#39;download&#39; returns download URL, &#39;formats&#39; lists available formats (default to ‘download’)

  • :format (String) —

    Desired format (when action&#x3D;download) (default to ‘video’)

  • :quality (String) —

    Desired quality (when action&#x3D;download) (default to ‘hd’)

  • :format_id (String) —

    Specific format ID from formats list

Returns:



517
518
519
520
521
522
523
524
525
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
579
580
 
# File 'lib/late-sdk/api/tools_api.rb', line 517

def download_you_tube_video_with_http_info(url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsApi.download_you_tube_video ...'
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling ToolsApi.download_you_tube_video"
  end
  allowable_values = ["download", "formats"]
  if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
    fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
  end
  allowable_values = ["video", "audio"]
  if @api_client.config.client_side_validation && opts[:'format'] && !allowable_values.include?(opts[:'format'])
    fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
  end
  allowable_values = ["hd", "sd"]
  if @api_client.config.client_side_validation && opts[:'quality'] && !allowable_values.include?(opts[:'quality'])
    fail ArgumentError, "invalid value for \"quality\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/tools/youtube/download'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'url'] = url
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'quality'] = opts[:'quality'] if !opts[:'quality'].nil?
  query_params[:'formatId'] = opts[:'format_id'] if !opts[:'format_id'].nil?

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

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

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

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

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

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

#get_you_tube_transcript(url, opts = {}) ⇒ GetYouTubeTranscript200Response

Get YouTube transcript Extract transcript/captions from a YouTube video. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    YouTube video URL or video ID

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

    the optional parameters

Options Hash (opts):

  • :lang (String) —

    Language code for transcript (default to ‘en’)

Returns:



588
589
590
591
 
# File 'lib/late-sdk/api/tools_api.rb', line 588

def get_you_tube_transcript(url, opts = {})
  data, _status_code, _headers = get_you_tube_transcript_with_http_info(url, opts)
  data
end

#get_you_tube_transcript_with_http_info(url, opts = {}) ⇒ Array<(GetYouTubeTranscript200Response, Integer, Hash)>

Get YouTube transcript Extract transcript/captions from a YouTube video. Rate limits: Build (50/day), Accelerate (500/day), Unlimited (unlimited).

Parameters:

  • url (String) —

    YouTube video URL or video ID

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

    the optional parameters

Options Hash (opts):

  • :lang (String) —

    Language code for transcript (default to ‘en’)

Returns:



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
 
# File 'lib/late-sdk/api/tools_api.rb', line 599

def get_you_tube_transcript_with_http_info(url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ToolsApi.get_you_tube_transcript ...'
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling ToolsApi.get_you_tube_transcript"
  end
  # resource path
  local_var_path = '/v1/tools/youtube/transcript'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'url'] = url
  query_params[:'lang'] = opts[:'lang'] if !opts[:'lang'].nil?

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

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

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

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

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

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