class Intrinio::DataTagApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/intrinio-sdk/api/data_tag_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_all_data_tags(opts = {}) click to toggle source

All Data Tags Returns all Data Tags. Returns Data Tags matching parameters when specified. @param [Hash] opts the optional parameters @option opts [String] :tag Tag @option opts [String] :type Type @option opts [String] :parent ID of tag parent @option opts [String] :statement_code Statement Code @option opts [String] :fs_template Template (default to industrial) @option opts [Integer] :page_size The number of results to return (default to 100) @option opts [String] :next_page Gets the next page of data from a previous API call @return [ApiResponseDataTags]

# File lib/intrinio-sdk/api/data_tag_api.rb, line 34
def get_all_data_tags(opts = {})
  data, _status_code, _headers = get_all_data_tags_with_http_info(opts)
  return data
end
get_all_data_tags_with_http_info(opts = {}) click to toggle source

All Data Tags Returns all Data Tags. Returns Data Tags matching parameters when specified. @param [Hash] opts the optional parameters @option opts [String] :tag Tag @option opts [String] :type Type @option opts [String] :parent ID of tag parent @option opts [String] :statement_code Statement Code @option opts [String] :fs_template Template @option opts [Integer] :page_size The number of results to return @option opts [String] :next_page Gets the next page of data from a previous API call @return [Array<(ApiResponseDataTags, Fixnum, Hash)>] ApiResponseDataTags data, response status code and response headers

# File lib/intrinio-sdk/api/data_tag_api.rb, line 50
def get_all_data_tags_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataTagApi.get_all_data_tags ..."
  end
  if @api_client.config.client_side_validation && opts[:'statement_code'] && !['income_statement', 'balance_sheet_statement', 'cash_flow_statement', 'calculations'].include?(opts[:'statement_code'])
    fail ArgumentError, 'invalid value for "statement_code", must be one of income_statement, balance_sheet_statement, cash_flow_statement, calculations'
  end
  if @api_client.config.client_side_validation && opts[:'fs_template'] && !['industrial', 'financial'].include?(opts[:'fs_template'])
    fail ArgumentError, 'invalid value for "fs_template", must be one of industrial, financial'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling DataTagApi.get_all_data_tags, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/data_tags"

  # query parameters
  query_params = {}
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'parent'] = opts[:'parent'] if !opts[:'parent'].nil?
  query_params[:'statement_code'] = opts[:'statement_code'] if !opts[:'statement_code'].nil?
  query_params[:'fs_template'] = opts[:'fs_template'] if !opts[:'fs_template'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # 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 => 'ApiResponseDataTags')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataTagApi#get_all_data_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_data_tag_by_id(identifier, opts = {}) click to toggle source

Lookup Data Tag Returns the Data Tag with the given `identifier` @param identifier The Intrinio ID or the code-name of the Data Tag @param [Hash] opts the optional parameters @return [DataTag]

# File lib/intrinio-sdk/api/data_tag_api.rb, line 106
def get_data_tag_by_id(identifier, opts = {})
  data, _status_code, _headers = get_data_tag_by_id_with_http_info(identifier, opts)
  return data
end
get_data_tag_by_id_with_http_info(identifier, opts = {}) click to toggle source

Lookup Data Tag Returns the Data Tag with the given &#x60;identifier&#x60; @param identifier The Intrinio ID or the code-name of the Data Tag @param [Hash] opts the optional parameters @return [Array<(DataTag, Fixnum, Hash)>] DataTag data, response status code and response headers

# File lib/intrinio-sdk/api/data_tag_api.rb, line 116
def get_data_tag_by_id_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataTagApi.get_data_tag_by_id ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling DataTagApi.get_data_tag_by_id"
  end
  # resource path
  local_var_path = "/data_tags/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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 => 'DataTag')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataTagApi#get_data_tag_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
search_data_tags(query, opts = {}) click to toggle source

Search Data Tags Searches for Data Tags matching the text `query` @param query @param [Hash] opts the optional parameters @option opts [Integer] :page_size The number of results to return (default to 100) @return [ApiResponseDataTagsSearch]

# File lib/intrinio-sdk/api/data_tag_api.rb, line 160
def search_data_tags(query, opts = {})
  data, _status_code, _headers = search_data_tags_with_http_info(query, opts)
  return data
end
search_data_tags_with_http_info(query, opts = {}) click to toggle source

Search Data Tags Searches for Data Tags matching the text &#x60;query&#x60; @param query @param [Hash] opts the optional parameters @option opts [Integer] :page_size The number of results to return @return [Array<(ApiResponseDataTagsSearch, Fixnum, Hash)>] ApiResponseDataTagsSearch data, response status code and response headers

# File lib/intrinio-sdk/api/data_tag_api.rb, line 171
def search_data_tags_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DataTagApi.search_data_tags ..."
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling DataTagApi.search_data_tags"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling DataTagApi.search_data_tags, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/data_tags/search"

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

  # 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 => 'ApiResponseDataTagsSearch')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DataTagApi#search_data_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end