Class: Intrinio::BulkDownloadsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/intrinio-sdk/api/bulk_downloads_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BulkDownloadsApi

Returns a new instance of BulkDownloadsApi.



19
20
21
 
# File 'lib/intrinio-sdk/api/bulk_downloads_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/intrinio-sdk/api/bulk_downloads_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

All Links Returns all active bulk downloads for your account with links to download.

Parameters:

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

    the optional parameters

Returns:



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

def get_bulk_download_links(opts = {})
  data, _status_code, _headers = get_bulk_download_links_with_http_info(opts)
  return data
end

#get_bulk_download_links_with_http_info(opts = {}) ⇒ Array<(ApiResponseBulkDownloadLinks, Fixnum, Hash)>

All Links Returns all active bulk downloads for your account with links to download.

Parameters:

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

    the optional parameters

Returns:



36
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
 
# File 'lib/intrinio-sdk/api/bulk_downloads_api.rb', line 36

def get_bulk_download_links_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BulkDownloadsApi.get_bulk_download_links ..."
  end
  # resource path
  local_var_path = "/bulk_downloads/links"

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseBulkDownloadLinks')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BulkDownloadsApi#get_bulk_download_links\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end