Class: Falcon::Downloads

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/downloads.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Downloads

Returns a new instance of Downloads.



35
36
37
 
# File 'lib/crimson-falcon/api/downloads.rb', line 35

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



33
34
35
 
# File 'lib/crimson-falcon/api/downloads.rb', line 33

def api_client
  @api_client
end

Instance Method Details

#download_file(file_name, file_version, opts = {}) ⇒ ModelsEntitiesResponse

Gets pre-signed URL for the file

Parameters:

  • file_name (String) —

    Name of the file to be downloaded

  • file_version (String) —

    Version of the file to be downloaded

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

    the optional parameters

Returns:



43
44
45
46
 
# File 'lib/crimson-falcon/api/downloads.rb', line 43

def download_file(file_name, file_version, opts = {})
  data, _status_code, _headers = download_file_with_http_info(file_name, file_version, opts)
  data
end

#download_file_with_http_info(file_name, file_version, opts = {}) ⇒ Array<(ModelsEntitiesResponse, Integer, Hash)>

Gets pre-signed URL for the file

Parameters:

  • file_name (String) —

    Name of the file to be downloaded

  • file_version (String) —

    Version of the file to be downloaded

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

    the optional parameters

Returns:

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

    ModelsEntitiesResponse data, response status code and response headers



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
103
104
105
 
# File 'lib/crimson-falcon/api/downloads.rb', line 53

def download_file_with_http_info(file_name, file_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Downloads.download_file ...'
  end
  # verify the required parameter 'file_name' is set
  if @api_client.config.client_side_validation && file_name.nil?
    fail ArgumentError, "Missing the required parameter 'file_name' when calling Downloads.download_file"
  end
  # verify the required parameter 'file_version' is set
  if @api_client.config.client_side_validation && file_version.nil?
    fail ArgumentError, "Missing the required parameter 'file_version' when calling Downloads.download_file"
  end
  # resource path
  local_var_path = '/csdownloads/entities/files/download/v1'

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

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

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

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