Class: NucleusApi::FinancialStatementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/api/financial_statement_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FinancialStatementApi

Returns a new instance of FinancialStatementApi.



19
20
21
 
# File 'lib/nucleus_api/api/financial_statement_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/nucleus_api/api/financial_statement_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_financial_statement_using_post(financial_statement, opts = {}) ⇒ FinancialStatement

Create an financialStatement Store stats pulled from financialStatement vendors.

Parameters:

  • financial_statement —

    financialStatement

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/nucleus_api/api/financial_statement_api.rb', line 27

def create_financial_statement_using_post(financial_statement, opts = {})
  data, _status_code, _headers = create_financial_statement_using_post_with_http_info(financial_statement, opts)
  data
end

#create_financial_statement_using_post_with_http_info(financial_statement, opts = {}) ⇒ Array<(FinancialStatement, Fixnum, Hash)>

Create an financialStatement Store stats pulled from financialStatement vendors.

Parameters:

  • financial_statement —

    financialStatement

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

    the optional parameters

Returns:

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

    FinancialStatement data, response status code and response headers



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
69
70
71
72
73
74
75
 
# File 'lib/nucleus_api/api/financial_statement_api.rb', line 37

def create_financial_statement_using_post_with_http_info(financial_statement, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FinancialStatementApi.create_financial_statement_using_post ...'
  end
  # verify the required parameter 'financial_statement' is set
  if @api_client.config.client_side_validation && financial_statement.nil?
    fail ArgumentError, "Missing the required parameter 'financial_statement' when calling FinancialStatementApi.create_financial_statement_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/financial_statement'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(financial_statement)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FinancialStatement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FinancialStatementApi#create_financial_statement_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_financial_statement_using_delete(financial_statement_id, opts = {}) ⇒ nil

Delete an financialStatement Permanently delete an financialStatement.

Parameters:

  • financial_statement_id —

    UUID financialStatement_id

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

    the optional parameters

Returns:

  • (nil) 


81
82
83
84
 
# File 'lib/nucleus_api/api/financial_statement_api.rb', line 81

def delete_financial_statement_using_delete(financial_statement_id, opts = {})
  delete_financial_statement_using_delete_with_http_info(financial_statement_id, opts)
  nil
end

#delete_financial_statement_using_delete_with_http_info(financial_statement_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an financialStatement Permanently delete an financialStatement.

Parameters:

  • financial_statement_id —

    UUID financialStatement_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/nucleus_api/api/financial_statement_api.rb', line 91

def delete_financial_statement_using_delete_with_http_info(financial_statement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FinancialStatementApi.delete_financial_statement_using_delete ...'
  end
  # verify the required parameter 'financial_statement_id' is set
  if @api_client.config.client_side_validation && financial_statement_id.nil?
    fail ArgumentError, "Missing the required parameter 'financial_statement_id' when calling FinancialStatementApi.delete_financial_statement_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/financial_statement/{financial_statement_id}'.sub('{' + 'financial_statement_id' + '}', financial_statement_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_financial_statement_all_using_get(opts = {}) ⇒ PageFinancialStatement

List all financialStatement Get information for all financialStatement for all clients defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



137
138
139
140
 
# File 'lib/nucleus_api/api/financial_statement_api.rb', line 137

def get_financial_statement_all_using_get(opts = {})
  data, _status_code, _headers = get_financial_statement_all_using_get_with_http_info(opts)
  data
end

#get_financial_statement_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageFinancialStatement, Fixnum, Hash)>

List all financialStatement Get information for all financialStatement for all clients defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageFinancialStatement data, response status code and response headers



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/nucleus_api/api/financial_statement_api.rb', line 152

def get_financial_statement_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FinancialStatementApi.get_financial_statement_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/financial_statement'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'PageFinancialStatement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FinancialStatementApi#get_financial_statement_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_financial_statement_using_get(financial_statement_id, opts = {}) ⇒ FinancialStatement

Retrieve an financialStatement Retrieve the information for a specific financialStatement associated with a client.

Parameters:

  • financial_statement_id —

    UUID financial_statement_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:



197
198
199
200
 
# File 'lib/nucleus_api/api/financial_statement_api.rb', line 197

def get_financial_statement_using_get(financial_statement_id, opts = {})
  data, _status_code, _headers = get_financial_statement_using_get_with_http_info(financial_statement_id, opts)
  data
end

#get_financial_statement_using_get_with_http_info(financial_statement_id, opts = {}) ⇒ Array<(FinancialStatement, Fixnum, Hash)>

Retrieve an financialStatement Retrieve the information for a specific financialStatement associated with a client.

Parameters:

  • financial_statement_id —

    UUID financial_statement_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:

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

    FinancialStatement data, response status code and response headers



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/nucleus_api/api/financial_statement_api.rb', line 208

def get_financial_statement_using_get_with_http_info(financial_statement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FinancialStatementApi.get_financial_statement_using_get ...'
  end
  # verify the required parameter 'financial_statement_id' is set
  if @api_client.config.client_side_validation && financial_statement_id.nil?
    fail ArgumentError, "Missing the required parameter 'financial_statement_id' when calling FinancialStatementApi.get_financial_statement_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/financial_statement/{financial_statement_id}'.sub('{' + 'financial_statement_id' + '}', financial_statement_id.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'FinancialStatement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FinancialStatementApi#get_financial_statement_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_financial_statement_using_put(financial_statement, financial_statement_id, opts = {}) ⇒ FinancialStatement

Update an financialStatement Update the information for an financialStatement.

Parameters:

  • financial_statement —

    financialStatement

  • financial_statement_id —

    UUID financialStatement_id

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

    the optional parameters

Returns:



252
253
254
255
 
# File 'lib/nucleus_api/api/financial_statement_api.rb', line 252

def update_financial_statement_using_put(financial_statement, financial_statement_id, opts = {})
  data, _status_code, _headers = update_financial_statement_using_put_with_http_info(financial_statement, financial_statement_id, opts)
  data
end

#update_financial_statement_using_put_with_http_info(financial_statement, financial_statement_id, opts = {}) ⇒ Array<(FinancialStatement, Fixnum, Hash)>

Update an financialStatement Update the information for an financialStatement.

Parameters:

  • financial_statement —

    financialStatement

  • financial_statement_id —

    UUID financialStatement_id

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

    the optional parameters

Returns:

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

    FinancialStatement data, response status code and response headers



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/nucleus_api/api/financial_statement_api.rb', line 263

def update_financial_statement_using_put_with_http_info(financial_statement, financial_statement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FinancialStatementApi.update_financial_statement_using_put ...'
  end
  # verify the required parameter 'financial_statement' is set
  if @api_client.config.client_side_validation && financial_statement.nil?
    fail ArgumentError, "Missing the required parameter 'financial_statement' when calling FinancialStatementApi.update_financial_statement_using_put"
  end
  # verify the required parameter 'financial_statement_id' is set
  if @api_client.config.client_side_validation && financial_statement_id.nil?
    fail ArgumentError, "Missing the required parameter 'financial_statement_id' when calling FinancialStatementApi.update_financial_statement_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/financial_statement/{financial_statement_id}'.sub('{' + 'financial_statement_id' + '}', financial_statement_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(financial_statement)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FinancialStatement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FinancialStatementApi#update_financial_statement_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end