Class: FireflyIIIClient::TagsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TagsApi

Returns a new instance of TagsApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_tag(tag, opts = {}) ⇒ nil

Delete an tag. Delete an tag.

Parameters:

  • tag (String) —

    Either the tag itself or the tag ID.

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_tag(tag, opts = {})
  delete_tag_with_http_info(tag, opts)
  nil
end

#delete_tag_with_http_info(tag, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an tag. Delete an tag.

Parameters:

  • tag (String) —

    Either the tag itself or the tag ID.

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 37

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

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"TagsApi.delete_tag",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#delete_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tag(tag, opts = {}) ⇒ TagSingle

Get a single tag. Get a single tag.

Parameters:

  • tag (String) —

    Either the tag itself or the tag ID.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

Returns:



89
90
91
92
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 89

def get_tag(tag, opts = {})
  data, _status_code, _headers = get_tag_with_http_info(tag, opts)
  data
end

#get_tag_cloud(start, _end, opts = {}) ⇒ TagCloud

Returns a basic tag cloud. Returns a list of tags, which can be used to draw a basic tag cloud.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:



155
156
157
158
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 155

def get_tag_cloud(start, _end, opts = {})
  data, _status_code, _headers = get_tag_cloud_with_http_info(start, _end, opts)
  data
end

#get_tag_cloud_with_http_info(start, _end, opts = {}) ⇒ Array<(TagCloud, Integer, Hash)>

Returns a basic tag cloud. Returns a list of tags, which can be used to draw a basic tag cloud.

Parameters:

  • start (Date) —

    A date formatted YYYY-MM-DD.

  • _end (Date) —

    A date formatted YYYY-MM-DD.

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

    the optional parameters

Returns:

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

    TagCloud data, response status code and response headers



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
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/tags_api.rb', line 166

def get_tag_cloud_with_http_info(start, _end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.get_tag_cloud ...'
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling TagsApi.get_tag_cloud"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling TagsApi.get_tag_cloud"
  end
  # resource path
  local_var_path = '/api/v1/tag-cloud'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start'] = start
  query_params[:'end'] = _end

  # 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] || 'TagCloud'

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

  new_options = opts.merge(
    :operation => :"TagsApi.get_tag_cloud",
    :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: TagsApi#get_tag_cloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tag_with_http_info(tag, opts = {}) ⇒ Array<(TagSingle, Integer, Hash)>

Get a single tag. Get a single tag.

Parameters:

  • tag (String) —

    Either the tag itself or the tag ID.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

Returns:

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

    TagSingle 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
144
145
146
147
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 100

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

  # 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] || 'TagSingle'

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

  new_options = opts.merge(
    :operation => :"TagsApi.get_tag",
    :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: TagsApi#get_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_tag(opts = {}) ⇒ TagArray

List all tags. List all of the user’s tags.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

Returns:



225
226
227
228
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 225

def list_tag(opts = {})
  data, _status_code, _headers = list_tag_with_http_info(opts)
  data
end

#list_tag_with_http_info(opts = {}) ⇒ Array<(TagArray, Integer, Hash)>

List all tags. List all of the user&#39;s tags.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

Returns:

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

    TagArray data, response status code and response headers



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
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
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 235

def list_tag_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.list_tag ...'
  end
  # resource path
  local_var_path = '/api/v1/tags'

  # 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] || 'TagArray'

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

  new_options = opts.merge(
    :operation => :"TagsApi.list_tag",
    :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: TagsApi#list_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_transaction_by_tag(tag, opts = {}) ⇒ TransactionArray

List all transactions with this tag. List all transactions with this tag.

Parameters:

  • tag (String) —

    Either the tag itself or the tag ID.

  • 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:



289
290
291
292
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 289

def list_transaction_by_tag(tag, opts = {})
  data, _status_code, _headers = list_transaction_by_tag_with_http_info(tag, opts)
  data
end

#list_transaction_by_tag_with_http_info(tag, opts = {}) ⇒ Array<(TransactionArray, Integer, Hash)>

List all transactions with this tag. List all transactions with this tag.

Parameters:

  • tag (String) —

    Either the tag itself or the tag ID.

  • 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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 303

def list_transaction_by_tag_with_http_info(tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.list_transaction_by_tag ...'
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling TagsApi.list_transaction_by_tag"
  end
  # resource path
  local_var_path = '/api/v1/tags/{tag}/transactions'.sub('{' + 'tag' + '}', CGI.escape(tag.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 => :"TagsApi.list_transaction_by_tag",
    :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: TagsApi#list_transaction_by_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#store_tag(tag_model, opts = {}) ⇒ TagSingle

Store a new tag Creates a new tag. The data required can be submitted as a JSON body or as a list of parameters.

Parameters:

  • tag_model (TagModel) —

    JSON array or key&#x3D;value pairs with the necessary tag information. See the model for the exact specifications.

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

    the optional parameters

Returns:



360
361
362
363
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 360

def store_tag(tag_model, opts = {})
  data, _status_code, _headers = store_tag_with_http_info(tag_model, opts)
  data
end

#store_tag_with_http_info(tag_model, opts = {}) ⇒ Array<(TagSingle, Integer, Hash)>

Store a new tag Creates a new tag. The data required can be submitted as a JSON body or as a list of parameters.

Parameters:

  • tag_model (TagModel) —

    JSON array or key&#x3D;value pairs with the necessary tag information. See the model for the exact specifications.

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

    the optional parameters

Returns:

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

    TagSingle data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 370

def store_tag_with_http_info(tag_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.store_tag ...'
  end
  # verify the required parameter 'tag_model' is set
  if @api_client.config.client_side_validation && tag_model.nil?
    fail ArgumentError, "Missing the required parameter 'tag_model' when calling TagsApi.store_tag"
  end
  # resource path
  local_var_path = '/api/v1/tags'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_model)

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

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

  new_options = opts.merge(
    :operation => :"TagsApi.store_tag",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#store_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_tag(tag, tag_model, opts = {}) ⇒ TagSingle

Update existing tag. Update existing tag.

Parameters:

  • tag (String) —

    Either the tag itself or the tag ID.

  • tag_model (TagModel) —

    JSON array with updated tag information. See the model for the exact specifications.

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

    the optional parameters

Returns:



426
427
428
429
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 426

def update_tag(tag, tag_model, opts = {})
  data, _status_code, _headers = update_tag_with_http_info(tag, tag_model, opts)
  data
end

#update_tag_with_http_info(tag, tag_model, opts = {}) ⇒ Array<(TagSingle, Integer, Hash)>

Update existing tag. Update existing tag.

Parameters:

  • tag (String) —

    Either the tag itself or the tag ID.

  • tag_model (TagModel) —

    JSON array with updated tag information. See the model for the exact specifications.

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

    the optional parameters

Returns:

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

    TagSingle data, response status code and response headers



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/firefly_iii_client/api/tags_api.rb', line 437

def update_tag_with_http_info(tag, tag_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TagsApi.update_tag ...'
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling TagsApi.update_tag"
  end
  # verify the required parameter 'tag_model' is set
  if @api_client.config.client_side_validation && tag_model.nil?
    fail ArgumentError, "Missing the required parameter 'tag_model' when calling TagsApi.update_tag"
  end
  # resource path
  local_var_path = '/api/v1/tags/{tag}'.sub('{' + 'tag' + '}', CGI.escape(tag.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(tag_model)

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

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

  new_options = opts.merge(
    :operation => :"TagsApi.update_tag",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TagsApi#update_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end