Class: Zernio::ToolsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/zernio-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/zernio-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/zernio-sdk/api/tools_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

Download a TikTok video Get a download URL or list available formats for a TikTok video. Requires Tools API access and uses the Tools API rate limit. Provider gateway failures and provider-side access blocks return 503; an unavailable video returns 404.

Parameters:

  • url (String) —

    TikTok video URL or numeric video ID.

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    Return a download URL or the available formats. (default to 'download')

  • :format_id (String) —

    Format ID from the formats response. Omit to select the first available format.

Returns:



29
30
31
32
 
# File 'lib/zernio-sdk/api/tools_api.rb', line 29

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 a TikTok video Get a download URL or list available formats for a TikTok video. Requires Tools API access and uses the Tools API rate limit. Provider gateway failures and provider-side access blocks return 503; an unavailable video returns 404.

Parameters:

  • url (String) —

    TikTok video URL or numeric video ID.

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

    the optional parameters

Options Hash (opts):

  • :action (String) —

    Return a download URL or the available formats. (default to 'download')

  • :format_id (String) —

    Format ID from the formats response. Omit to select the first available format.

Returns:



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
89
90
91
92
93
94
 
# File 'lib/zernio-sdk/api/tools_api.rb', line 41

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