Class: Falcon::DownloadsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DownloadsApi

Returns a new instance of DownloadsApi.



36
37
38
 
# File 'lib/crimson-falcon/api/downloads_api.rb', line 36

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/downloads_api.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#enumerate_file(opts = {}) ⇒ CommonEntitiesResponse

Enumerates a list of files available for CID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file_name (String) —

    Apply filtering on file name

  • :file_version (String) —

    Apply filtering on file version

  • :platform (String) —

    Apply filtering on file platform

  • :os (String) —

    Apply filtering on operating system

  • :arch (String) —

    Apply filtering on architecture

  • :category (String) —

    Apply filtering on file category

Returns:



48
49
50
51
 
# File 'lib/crimson-falcon/api/downloads_api.rb', line 48

def enumerate_file(opts = {})
  data, _status_code, _headers = enumerate_file_with_http_info(opts)
  data
end

#enumerate_file_with_http_info(opts = {}) ⇒ Array<(CommonEntitiesResponse, Integer, Hash)>

Enumerates a list of files available for CID

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file_name (String) —

    Apply filtering on file name

  • :file_version (String) —

    Apply filtering on file version

  • :platform (String) —

    Apply filtering on file platform

  • :os (String) —

    Apply filtering on operating system

  • :arch (String) —

    Apply filtering on architecture

  • :category (String) —

    Apply filtering on file category

Returns:

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

    CommonEntitiesResponse data, response status code and response headers



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
106
107
108
109
110
 
# File 'lib/crimson-falcon/api/downloads_api.rb', line 62

def enumerate_file_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DownloadsApi.enumerate_file ...'
  end
  # resource path
  local_var_path = '/csdownloads/entities/files/enumerate/v1'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'file_name'] = opts[:'file_name'] if !opts[:'file_name'].nil?
  query_params[:'file_version'] = opts[:'file_version'] if !opts[:'file_version'].nil?
  query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil?
  query_params[:'os'] = opts[:'os'] if !opts[:'os'].nil?
  query_params[:'arch'] = opts[:'arch'] if !opts[:'arch'].nil?
  query_params[:'category'] = opts[:'category'] if !opts[:'category'].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] || 'CommonEntitiesResponse'

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

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