Class: Intrinio::DataTagApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DataTagApi

Returns a new instance of DataTagApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_all_data_tags(opts = {}) ⇒ ApiResponseDataTags

All Data Tags Returns all Data Tags. Returns Data Tags matching parameters when specified.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :tag (String) —

    Tag

  • :type (String) —

    Type

  • :parent (String) —

    ID of tag parent

  • :statement_code (String) —

    Statement Code

  • :fs_template (String) —

    Template (default to industrial)

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



34
35
36
37
 
# 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 = {}) ⇒ Array<(ApiResponseDataTags, Fixnum, Hash)>

All Data Tags Returns all Data Tags. Returns Data Tags matching parameters when specified.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :tag (String) —

    Tag

  • :type (String) —

    Type

  • :parent (String) —

    ID of tag parent

  • :statement_code (String) —

    Statement Code

  • :fs_template (String) —

    Template

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:

  • (Array<(ApiResponseDataTags, Fixnum, Hash)>) —

    ApiResponseDataTags data, response status code and response headers



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
95
96
97
98
99
 
# 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 = {}) ⇒ DataTag

Lookup Data Tag Returns the Data Tag with the given ‘identifier`

Parameters:

  • identifier —

    The Intrinio ID or the code-name of the Data Tag

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

    the optional parameters

Returns:



106
107
108
109
 
# 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 = {}) ⇒ Array<(DataTag, Fixnum, Hash)>

Lookup Data Tag Returns the Data Tag with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

    The Intrinio ID or the code-name of the Data Tag

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

    the optional parameters

Returns:

  • (Array<(DataTag, Fixnum, Hash)>) —

    DataTag data, response status code and response headers



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# 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 = {}) ⇒ ApiResponseDataTagsSearch

Search Data Tags Searches for Data Tags matching the text ‘query`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return (default to 100)

Returns:



160
161
162
163
 
# 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 = {}) ⇒ Array<(ApiResponseDataTagsSearch, Fixnum, Hash)>

Search Data Tags Searches for Data Tags matching the text &#x60;query&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

Returns:

  • (Array<(ApiResponseDataTagsSearch, Fixnum, Hash)>) —

    ApiResponseDataTagsSearch data, response status code and response headers



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# 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