Class: FireflyIIIClient::ImportApi

Inherits:
Object
  • Object
show all
Defined in:
lib/firefly_iii_client/api/import_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ImportApi

Returns a new instance of ImportApi.



19
20
21
 
# File 'lib/firefly_iii_client/api/import_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/firefly_iii_client/api/import_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_import(key, opts = {}) ⇒ ImportJobSingle

Show info on a single import Show info on single import.

Parameters:

  • key (String) —

    The job key of an import job.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/firefly_iii_client/api/import_api.rb', line 27

def get_import(key, opts = {})
  data, _status_code, _headers = get_import_with_http_info(key, opts)
  data
end

#get_import_with_http_info(key, opts = {}) ⇒ Array<(ImportJobSingle, Integer, Hash)>

Show info on a single import Show info on single import.

Parameters:

  • key (String) —

    The job key of an import job.

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

    the optional parameters

Returns:

  • (Array<(ImportJobSingle, Integer, Hash)>) —

    ImportJobSingle 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
76
77
78
79
80
81
82
83
 
# File 'lib/firefly_iii_client/api/import_api.rb', line 37

def get_import_with_http_info(key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImportApi.get_import ...'
  end
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    fail ArgumentError, "Missing the required parameter 'key' when calling ImportApi.get_import"
  end
  # resource path
  local_var_path = '/api/v1/import/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ImportJobSingle'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']

  new_options = opts.merge(
    :operation => :"ImportApi.get_import",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImportApi#get_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_import(opts = {}) ⇒ ImportJobArray

List al imports List all imports

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is per 50 items.

Returns:



90
91
92
93
 
# File 'lib/firefly_iii_client/api/import_api.rb', line 90

def list_import(opts = {})
  data, _status_code, _headers = list_import_with_http_info(opts)
  data
end

#list_import_with_http_info(opts = {}) ⇒ Array<(ImportJobArray, Integer, Hash)>

List al imports List all imports

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is per 50 items.

Returns:

  • (Array<(ImportJobArray, Integer, Hash)>) —

    ImportJobArray data, response status code and response headers



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/firefly_iii_client/api/import_api.rb', line 100

def list_import_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImportApi.list_import ...'
  end
  # resource path
  local_var_path = '/api/v1/import/list'

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ImportJobArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']

  new_options = opts.merge(
    :operation => :"ImportApi.list_import",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImportApi#list_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_transaction_by_import(key, opts = {}) ⇒ TransactionArray

List all transactions related to the import job. The correlation is made through the tag. See summary

Parameters:

  • key (String) —

    The key of the import job

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

  • :start (Date) —

    A date formatted YYYY-MM-DD. This is the start date of the selected range (inclusive).

  • :_end (Date) —

    A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive).

  • :type (TransactionTypeFilter) —

    Optional filter on the transaction type(s) returned.

Returns:



154
155
156
157
 
# File 'lib/firefly_iii_client/api/import_api.rb', line 154

def list_transaction_by_import(key, opts = {})
  data, _status_code, _headers = list_transaction_by_import_with_http_info(key, opts)
  data
end

#list_transaction_by_import_with_http_info(key, opts = {}) ⇒ Array<(TransactionArray, Integer, Hash)>

List all transactions related to the import job. The correlation is made through the tag. See summary

Parameters:

  • key (String) —

    The key of the import job

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number. The default pagination is 50.

  • :start (Date) —

    A date formatted YYYY-MM-DD. This is the start date of the selected range (inclusive).

  • :_end (Date) —

    A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive).

  • :type (TransactionTypeFilter) —

    Optional filter on the transaction type(s) returned.

Returns:

  • (Array<(TransactionArray, Integer, Hash)>) —

    TransactionArray data, response status code and response headers



168
169
170
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
214
215
216
217
218
 
# File 'lib/firefly_iii_client/api/import_api.rb', line 168

def list_transaction_by_import_with_http_info(key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ImportApi.list_transaction_by_import ...'
  end
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    fail ArgumentError, "Missing the required parameter 'key' when calling ImportApi.list_transaction_by_import"
  end
  # resource path
  local_var_path = '/api/v1/import/{key}/transactions'.sub('{' + 'key' + '}', CGI.escape(key.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
  query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionArray'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['firefly_iii_auth']

  new_options = opts.merge(
    :operation => :"ImportApi.list_transaction_by_import",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ImportApi#list_transaction_by_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end