Class: ProtonApi::BusinessFinancialManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/api/business_financial_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BusinessFinancialManagementApi

Returns a new instance of BusinessFinancialManagementApi.



19
20
21
 
# File 'lib/proton_api/api/business_financial_management_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/proton_api/api/business_financial_management_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#business_financial_health_check(business_financial_health_check_request, opts = {}) ⇒ Hash<String, Object>

Business Financial Health Check Calculate a series of financial ratios to assess business financial health

Parameters:

  • business_financial_health_check_request —

    Request payload for Business Financial Health Check

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


27
28
29
30
 
# File 'lib/proton_api/api/business_financial_management_api.rb', line 27

def business_financial_health_check(business_financial_health_check_request, opts = {})
  data, _status_code, _headers = business_financial_health_check_with_http_info(business_financial_health_check_request, opts)
  data
end

#business_financial_health_check_with_http_info(business_financial_health_check_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Business Financial Health Check Calculate a series of financial ratios to assess business financial health

Parameters:

  • business_financial_health_check_request —

    Request payload for Business Financial Health Check

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> 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/proton_api/api/business_financial_management_api.rb', line 37

def business_financial_health_check_with_http_info(business_financial_health_check_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessFinancialManagementApi.business_financial_health_check ...'
  end
  # verify the required parameter 'business_financial_health_check_request' is set
  if @api_client.config.client_side_validation && business_financial_health_check_request.nil?
    fail ArgumentError, "Missing the required parameter 'business_financial_health_check_request' when calling BusinessFinancialManagementApi.business_financial_health_check"
  end
  # resource path
  local_var_path = '/business/financial_health_check'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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(business_financial_health_check_request)
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BusinessFinancialManagementApi#business_financial_health_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cash_analysis(cash_analysis_request, opts = {}) ⇒ Hash<String, Object>

Cash Analysis Analyze cash activity over time

Parameters:

  • cash_analysis_request —

    Request payload for Cash Analysis

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


81
82
83
84
 
# File 'lib/proton_api/api/business_financial_management_api.rb', line 81

def cash_analysis(cash_analysis_request, opts = {})
  data, _status_code, _headers = cash_analysis_with_http_info(cash_analysis_request, opts)
  data
end

#cash_analysis_with_http_info(cash_analysis_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Cash Analysis Analyze cash activity over time

Parameters:

  • cash_analysis_request —

    Request payload for Cash Analysis

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, 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
127
128
129
 
# File 'lib/proton_api/api/business_financial_management_api.rb', line 91

def cash_analysis_with_http_info(cash_analysis_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessFinancialManagementApi.cash_analysis ...'
  end
  # verify the required parameter 'cash_analysis_request' is set
  if @api_client.config.client_side_validation && cash_analysis_request.nil?
    fail ArgumentError, "Missing the required parameter 'cash_analysis_request' when calling BusinessFinancialManagementApi.cash_analysis"
  end
  # resource path
  local_var_path = '/business/cash_analysis'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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(cash_analysis_request)
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BusinessFinancialManagementApi#cash_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#customer_analysis(customer_analysis_request, opts = {}) ⇒ Hash<String, Object>

Customer Analysis Analyze customer revenues over a time period

Parameters:

  • customer_analysis_request —

    Request payload for Customer Analysis

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


135
136
137
138
 
# File 'lib/proton_api/api/business_financial_management_api.rb', line 135

def customer_analysis(customer_analysis_request, opts = {})
  data, _status_code, _headers = customer_analysis_with_http_info(customer_analysis_request, opts)
  data
end

#customer_analysis_with_http_info(customer_analysis_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Customer Analysis Analyze customer revenues over a time period

Parameters:

  • customer_analysis_request —

    Request payload for Customer Analysis

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



145
146
147
148
149
150
151
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
 
# File 'lib/proton_api/api/business_financial_management_api.rb', line 145

def customer_analysis_with_http_info(customer_analysis_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessFinancialManagementApi.customer_analysis ...'
  end
  # verify the required parameter 'customer_analysis_request' is set
  if @api_client.config.client_side_validation && customer_analysis_request.nil?
    fail ArgumentError, "Missing the required parameter 'customer_analysis_request' when calling BusinessFinancialManagementApi.customer_analysis"
  end
  # resource path
  local_var_path = '/business/customer_analysis'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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(customer_analysis_request)
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BusinessFinancialManagementApi#customer_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#financial_statement_analysis(financial_statement_analysis_request, opts = {}) ⇒ Hash<String, Object>

Financial Statement Analysis Analyze financial statement accounting data for a business

Parameters:

  • financial_statement_analysis_request —

    Request payload for Financial Statement Analysis

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


189
190
191
192
 
# File 'lib/proton_api/api/business_financial_management_api.rb', line 189

def financial_statement_analysis(financial_statement_analysis_request, opts = {})
  data, _status_code, _headers = financial_statement_analysis_with_http_info(financial_statement_analysis_request, opts)
  data
end

#financial_statement_analysis_with_http_info(financial_statement_analysis_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Financial Statement Analysis Analyze financial statement accounting data for a business

Parameters:

  • financial_statement_analysis_request —

    Request payload for Financial Statement Analysis

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



199
200
201
202
203
204
205
206
207
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
 
# File 'lib/proton_api/api/business_financial_management_api.rb', line 199

def financial_statement_analysis_with_http_info(financial_statement_analysis_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessFinancialManagementApi.financial_statement_analysis ...'
  end
  # verify the required parameter 'financial_statement_analysis_request' is set
  if @api_client.config.client_side_validation && financial_statement_analysis_request.nil?
    fail ArgumentError, "Missing the required parameter 'financial_statement_analysis_request' when calling BusinessFinancialManagementApi.financial_statement_analysis"
  end
  # resource path
  local_var_path = '/business/financial_statement_analysis'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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_analysis_request)
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BusinessFinancialManagementApi#financial_statement_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invoice_analysis(invoice_analysis_request, opts = {}) ⇒ Hash<String, Object>

Invoice Analysis Analyze invoices to understand the context of money owed and paid to a business

Parameters:

  • invoice_analysis_request —

    Request payload for Invoice Analysis

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


243
244
245
246
 
# File 'lib/proton_api/api/business_financial_management_api.rb', line 243

def invoice_analysis(invoice_analysis_request, opts = {})
  data, _status_code, _headers = invoice_analysis_with_http_info(invoice_analysis_request, opts)
  data
end

#invoice_analysis_with_http_info(invoice_analysis_request, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Invoice Analysis Analyze invoices to understand the context of money owed and paid to a business

Parameters:

  • invoice_analysis_request —

    Request payload for Invoice Analysis

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



253
254
255
256
257
258
259
260
261
262
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
 
# File 'lib/proton_api/api/business_financial_management_api.rb', line 253

def invoice_analysis_with_http_info(invoice_analysis_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessFinancialManagementApi.invoice_analysis ...'
  end
  # verify the required parameter 'invoice_analysis_request' is set
  if @api_client.config.client_side_validation && invoice_analysis_request.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_analysis_request' when calling BusinessFinancialManagementApi.invoice_analysis"
  end
  # resource path
  local_var_path = '/business/invoice_analysis'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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(invoice_analysis_request)
  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 => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BusinessFinancialManagementApi#invoice_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end