Class: BudgeaClient::AdministrationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/api/administration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AdministrationApi

Returns a new instance of AdministrationApi.



19
20
21
 
# File 'lib/budgea_client/api/administration_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/budgea_client/api/administration_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#clients_get(opts = {}) ⇒ InlineResponse20013

List clients

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



27
28
29
30
 
# File 'lib/budgea_client/api/administration_api.rb', line 27

def clients_get(opts = {})
  data, _status_code, _headers = clients_get_with_http_info(opts)
  data
end

#clients_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20013, Fixnum, Hash)>

List clients

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20013 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
 
# File 'lib/budgea_client/api/administration_api.rb', line 37

def clients_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.clients_get ...'
  end
  # resource path
  local_var_path = '/clients'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#clients_id_client_delete(id_client, opts = {}) ⇒ Client

Delete a client

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



79
80
81
82
 
# File 'lib/budgea_client/api/administration_api.rb', line 79

def clients_id_client_delete(id_client, opts = {})
  data, _status_code, _headers = clients_id_client_delete_with_http_info(id_client, opts)
  data
end

#clients_id_client_delete_with_http_info(id_client, opts = {}) ⇒ Array<(Client, Fixnum, Hash)>

Delete a client

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Client data, response status code and response headers



90
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/budgea_client/api/administration_api.rb', line 90

def clients_id_client_delete_with_http_info(id_client, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.clients_id_client_delete ...'
  end
  # verify the required parameter 'id_client' is set
  if @api_client.config.client_side_validation && id_client.nil?
    fail ArgumentError, "Missing the required parameter 'id_client' when calling AdministrationApi.clients_id_client_delete"
  end
  # resource path
  local_var_path = '/clients/{id_client}'.sub('{' + 'id_client' + '}', id_client.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#clients_id_client_get(id_client, opts = {}) ⇒ Client

Get information about a client If you use the manage_token or a configuration token, you will get also the client secret.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



136
137
138
139
 
# File 'lib/budgea_client/api/administration_api.rb', line 136

def clients_id_client_get(id_client, opts = {})
  data, _status_code, _headers = clients_id_client_get_with_http_info(id_client, opts)
  data
end

#clients_id_client_get_with_http_info(id_client, opts = {}) ⇒ Array<(Client, Fixnum, Hash)>

Get information about a client If you use the manage_token or a configuration token, you will get also the client secret.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Client data, response status code and response headers



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
184
185
186
 
# File 'lib/budgea_client/api/administration_api.rb', line 147

def clients_id_client_get_with_http_info(id_client, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.clients_id_client_get ...'
  end
  # verify the required parameter 'id_client' is set
  if @api_client.config.client_side_validation && id_client.nil?
    fail ArgumentError, "Missing the required parameter 'id_client' when calling AdministrationApi.clients_id_client_get"
  end
  # resource path
  local_var_path = '/clients/{id_client}'.sub('{' + 'id_client' + '}', id_client.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#clients_id_client_logo_delete(id_client, opts = {}) ⇒ File

Delete the client logo

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



193
194
195
196
 
# File 'lib/budgea_client/api/administration_api.rb', line 193

def clients_id_client_logo_delete(id_client, opts = {})
  data, _status_code, _headers = clients_id_client_logo_delete_with_http_info(id_client, opts)
  data
end

#clients_id_client_logo_delete_with_http_info(id_client, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Delete the client logo

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    File data, response status code and response headers



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
238
239
240
241
242
243
 
# File 'lib/budgea_client/api/administration_api.rb', line 204

def clients_id_client_logo_delete_with_http_info(id_client, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.clients_id_client_logo_delete ...'
  end
  # verify the required parameter 'id_client' is set
  if @api_client.config.client_side_validation && id_client.nil?
    fail ArgumentError, "Missing the required parameter 'id_client' when calling AdministrationApi.clients_id_client_logo_delete"
  end
  # resource path
  local_var_path = '/clients/{id_client}/logo'.sub('{' + 'id_client' + '}', id_client.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#clients_id_client_logo_post(id_client, opts = {}) ⇒ File

Update the client logo

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



250
251
252
253
 
# File 'lib/budgea_client/api/administration_api.rb', line 250

def clients_id_client_logo_post(id_client, opts = {})
  data, _status_code, _headers = clients_id_client_logo_post_with_http_info(id_client, opts)
  data
end

#clients_id_client_logo_post_with_http_info(id_client, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Update the client logo

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    File data, response status code and response headers



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
292
293
294
295
296
297
298
299
300
 
# File 'lib/budgea_client/api/administration_api.rb', line 261

def clients_id_client_logo_post_with_http_info(id_client, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.clients_id_client_logo_post ...'
  end
  # verify the required parameter 'id_client' is set
  if @api_client.config.client_side_validation && id_client.nil?
    fail ArgumentError, "Missing the required parameter 'id_client' when calling AdministrationApi.clients_id_client_logo_post"
  end
  # resource path
  local_var_path = '/clients/{id_client}/logo'.sub('{' + 'id_client' + '}', id_client.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#clients_id_client_put(id_client, opts = {}) ⇒ Client

Update a client

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :generate_keys (BOOLEAN) —

    set a rsa key pair for the client, which make it possible to generate a jwt user token using this client. No effect if the client already has a set of keys(default: False)

  • :name (String) —

    name of client

  • :secret (BOOLEAN) —

    reset the secret

  • :redirect_uris (String) —

    list of allowed redirect uris

  • :primary_color (String) —

    hexadecimal code of the client primary color (e.g F45B9A)

  • :secondary_color (String) —

    hexadecimal code of the client secondary color (e.g F45B9A)

  • :description (String) —

    text to display as a default description

  • :description_banks (String) —

    text to display as a description for banks

  • :description_providers (String) —

    text to display as a description for providers

  • :pro (BOOLEAN) —

    Wether the client should display the company manager page

  • :config (String) —

    custom config about the client

  • :update_config (BOOLEAN) —

    update the custom information about the client instead of replacing the existing one (default: True)

  • :expand (String)

Returns:



319
320
321
322
 
# File 'lib/budgea_client/api/administration_api.rb', line 319

def clients_id_client_put(id_client, opts = {})
  data, _status_code, _headers = clients_id_client_put_with_http_info(id_client, opts)
  data
end

#clients_id_client_put_with_http_info(id_client, opts = {}) ⇒ Array<(Client, Fixnum, Hash)>

Update a client

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :generate_keys (BOOLEAN) —

    set a rsa key pair for the client, which make it possible to generate a jwt user token using this client. No effect if the client already has a set of keys(default: False)

  • :name (String) —

    name of client

  • :secret (BOOLEAN) —

    reset the secret

  • :redirect_uris (String) —

    list of allowed redirect uris

  • :primary_color (String) —

    hexadecimal code of the client primary color (e.g F45B9A)

  • :secondary_color (String) —

    hexadecimal code of the client secondary color (e.g F45B9A)

  • :description (String) —

    text to display as a default description

  • :description_banks (String) —

    text to display as a description for banks

  • :description_providers (String) —

    text to display as a description for providers

  • :pro (BOOLEAN) —

    Wether the client should display the company manager page

  • :config (String) —

    custom config about the client

  • :update_config (BOOLEAN) —

    update the custom information about the client instead of replacing the existing one (default: True)

  • :expand (String)

Returns:

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

    Client data, response status code and response headers



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/budgea_client/api/administration_api.rb', line 342

def clients_id_client_put_with_http_info(id_client, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.clients_id_client_put ...'
  end
  # verify the required parameter 'id_client' is set
  if @api_client.config.client_side_validation && id_client.nil?
    fail ArgumentError, "Missing the required parameter 'id_client' when calling AdministrationApi.clients_id_client_put"
  end
  # resource path
  local_var_path = '/clients/{id_client}'.sub('{' + 'id_client' + '}', id_client.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['generate_keys'] = opts[:'generate_keys'] if !opts[:'generate_keys'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['secret'] = opts[:'secret'] if !opts[:'secret'].nil?
  form_params['redirect_uris'] = opts[:'redirect_uris'] if !opts[:'redirect_uris'].nil?
  form_params['primary_color'] = opts[:'primary_color'] if !opts[:'primary_color'].nil?
  form_params['secondary_color'] = opts[:'secondary_color'] if !opts[:'secondary_color'].nil?
  form_params['description'] = opts[:'description'] if !opts[:'description'].nil?
  form_params['description_banks'] = opts[:'description_banks'] if !opts[:'description_banks'].nil?
  form_params['description_providers'] = opts[:'description_providers'] if !opts[:'description_providers'].nil?
  form_params['pro'] = opts[:'pro'] if !opts[:'pro'].nil?
  form_params['config'] = opts[:'config'] if !opts[:'config'].nil?
  form_params['update_config'] = opts[:'update_config'] if !opts[:'update_config'].nil?

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

#clients_post(opts = {}) ⇒ Client

Create a client

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :generate_keys (BOOLEAN) —

    if True, generate a rsa pair of keys so the client can be used to generate jwt user tokens (default: False)

  • :name (String) —

    name of client

  • :redirect_uris (String) —

    list of allowed redirect uris

  • :config (String) —

    custom config about the client

  • :expand (String)

Returns:



403
404
405
406
 
# File 'lib/budgea_client/api/administration_api.rb', line 403

def clients_post(opts = {})
  data, _status_code, _headers = clients_post_with_http_info(opts)
  data
end

#clients_post_with_http_info(opts = {}) ⇒ Array<(Client, Fixnum, Hash)>

Create a client

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :generate_keys (BOOLEAN) —

    if True, generate a rsa pair of keys so the client can be used to generate jwt user tokens (default: False)

  • :name (String) —

    name of client

  • :redirect_uris (String) —

    list of allowed redirect uris

  • :config (String) —

    custom config about the client

  • :expand (String)

Returns:

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

    Client data, response status code and response headers



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/budgea_client/api/administration_api.rb', line 417

def clients_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.clients_post ...'
  end
  # resource path
  local_var_path = '/clients'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['generate_keys'] = opts[:'generate_keys'] if !opts[:'generate_keys'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['redirect_uris'] = opts[:'redirect_uris'] if !opts[:'redirect_uris'].nil?
  form_params['config'] = opts[:'config'] if !opts[:'config'].nil?

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

#config_get(opts = {}) ⇒ nil

Get configuration of the API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    limit the results to keys matching the given value

Returns:

  • (nil) 


462
463
464
465
 
# File 'lib/budgea_client/api/administration_api.rb', line 462

def config_get(opts = {})
  config_get_with_http_info(opts)
  nil
end

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

Get configuration of the API. &lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    limit the results to keys matching the given value

Returns:

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

    nil, response status code and response headers



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/budgea_client/api/administration_api.rb', line 472

def config_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.config_get ...'
  end
  # resource path
  local_var_path = '/config'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#config_logs_get(opts = {}) ⇒ InlineResponse20014

Get configuration change history of the API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    limit the results to keys matching the given value

  • :type (String) —

    type of change done on the configuration

  • :min_date (Date) —

    minimal date of the change

  • :max_date (Date) —

    maximum date of the change

  • :expand (String)

Returns:



516
517
518
519
 
# File 'lib/budgea_client/api/administration_api.rb', line 516

def config_logs_get(opts = {})
  data, _status_code, _headers = config_logs_get_with_http_info(opts)
  data
end

#config_logs_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20014, Fixnum, Hash)>

Get configuration change history of the API. &lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    limit the results to keys matching the given value

  • :type (String) —

    type of change done on the configuration

  • :min_date (Date) —

    minimal date of the change

  • :max_date (Date) —

    maximum date of the change

  • :expand (String)

Returns:

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

    InlineResponse20014 data, response status code and response headers



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/budgea_client/api/administration_api.rb', line 530

def config_logs_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.config_logs_get ...'
  end
  # resource path
  local_var_path = '/config/logs'

  # query parameters
  query_params = {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#config_post(opts = {}) ⇒ Object

Set a configuration value on the API. Request: { "connection.disable_new": "0", "search": "connection.disable_new" }

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    limit the results to keys matching the given value

Returns:

  • (Object) 


575
576
577
578
 
# File 'lib/budgea_client/api/administration_api.rb', line 575

def config_post(opts = {})
  data, _status_code, _headers = config_post_with_http_info(opts)
  data
end

#config_post_with_http_info(opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Set a configuration value on the API. Request: { &quot;connection.disable_new&quot;: &quot;0&quot;, &quot;search&quot;: &quot;connection.disable_new&quot; }&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    limit the results to keys matching the given value

Returns:

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

    Object data, response status code and response headers



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/budgea_client/api/administration_api.rb', line 585

def config_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.config_post ...'
  end
  # resource path
  local_var_path = '/config'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#merchants_get(opts = {}) ⇒ InlineResponse20013

List clients

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



626
627
628
629
 
# File 'lib/budgea_client/api/administration_api.rb', line 626

def merchants_get(opts = {})
  data, _status_code, _headers = merchants_get_with_http_info(opts)
  data
end

#merchants_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20013, Fixnum, Hash)>

List clients

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20013 data, response status code and response headers



636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/budgea_client/api/administration_api.rb', line 636

def merchants_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.merchants_get ...'
  end
  # resource path
  local_var_path = '/merchants'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#merchants_id_client_logo_delete(id_client, opts = {}) ⇒ File

Delete the client logo

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



678
679
680
681
 
# File 'lib/budgea_client/api/administration_api.rb', line 678

def merchants_id_client_logo_delete(id_client, opts = {})
  data, _status_code, _headers = merchants_id_client_logo_delete_with_http_info(id_client, opts)
  data
end

#merchants_id_client_logo_delete_with_http_info(id_client, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Delete the client logo

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    File data, response status code and response headers



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/budgea_client/api/administration_api.rb', line 689

def merchants_id_client_logo_delete_with_http_info(id_client, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.merchants_id_client_logo_delete ...'
  end
  # verify the required parameter 'id_client' is set
  if @api_client.config.client_side_validation && id_client.nil?
    fail ArgumentError, "Missing the required parameter 'id_client' when calling AdministrationApi.merchants_id_client_logo_delete"
  end
  # resource path
  local_var_path = '/merchants/{id_client}/logo'.sub('{' + 'id_client' + '}', id_client.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#merchants_id_client_logo_post(id_client, opts = {}) ⇒ File

Update the client logo

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



735
736
737
738
 
# File 'lib/budgea_client/api/administration_api.rb', line 735

def merchants_id_client_logo_post(id_client, opts = {})
  data, _status_code, _headers = merchants_id_client_logo_post_with_http_info(id_client, opts)
  data
end

#merchants_id_client_logo_post_with_http_info(id_client, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Update the client logo

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    File data, response status code and response headers



746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/budgea_client/api/administration_api.rb', line 746

def merchants_id_client_logo_post_with_http_info(id_client, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.merchants_id_client_logo_post ...'
  end
  # verify the required parameter 'id_client' is set
  if @api_client.config.client_side_validation && id_client.nil?
    fail ArgumentError, "Missing the required parameter 'id_client' when calling AdministrationApi.merchants_id_client_logo_post"
  end
  # resource path
  local_var_path = '/merchants/{id_client}/logo'.sub('{' + 'id_client' + '}', id_client.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#merchants_post(name, redirect_uris, iban, opts = {}) ⇒ Client

Create a merchant. Needs a user identified in bearer to be used

Parameters:

  • name —

    name of merchant

  • redirect_uris —

    list of allowed redirect uris

  • iban —

    payments initiated by this merchant will be done to this IBAN

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



794
795
796
797
 
# File 'lib/budgea_client/api/administration_api.rb', line 794

def merchants_post(name, redirect_uris, iban, opts = {})
  data, _status_code, _headers = merchants_post_with_http_info(name, redirect_uris, iban, opts)
  data
end

#merchants_post_with_http_info(name, redirect_uris, iban, opts = {}) ⇒ Array<(Client, Fixnum, Hash)>

Create a merchant. Needs a user identified in bearer to be used

Parameters:

  • name —

    name of merchant

  • redirect_uris —

    list of allowed redirect uris

  • iban —

    payments initiated by this merchant will be done to this IBAN

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Client data, response status code and response headers



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/budgea_client/api/administration_api.rb', line 807

def merchants_post_with_http_info(name, redirect_uris, iban, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.merchants_post ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling AdministrationApi.merchants_post"
  end
  # verify the required parameter 'redirect_uris' is set
  if @api_client.config.client_side_validation && redirect_uris.nil?
    fail ArgumentError, "Missing the required parameter 'redirect_uris' when calling AdministrationApi.merchants_post"
  end
  # verify the required parameter 'iban' is set
  if @api_client.config.client_side_validation && iban.nil?
    fail ArgumentError, "Missing the required parameter 'iban' when calling AdministrationApi.merchants_post"
  end
  # resource path
  local_var_path = '/merchants'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['name'] = name
  form_params['redirect_uris'] = redirect_uris
  form_params['iban'] = iban

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

#monitoring_get(opts = {}) ⇒ nil

get performances stats on this instance

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    number on days on which stats on synchronization have to be done per worker (Default: 1)

Returns:

  • (nil) 


863
864
865
866
 
# File 'lib/budgea_client/api/administration_api.rb', line 863

def monitoring_get(opts = {})
  monitoring_get_with_http_info(opts)
  nil
end

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

get performances stats on this instance

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    number on days on which stats on synchronization have to be done per worker (Default: 1)

Returns:

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

    nil, response status code and response headers



873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
 
# File 'lib/budgea_client/api/administration_api.rb', line 873

def monitoring_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.monitoring_get ...'
  end
  # resource path
  local_var_path = '/monitoring'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#test_sync_post(opts = {}) ⇒ nil

Test synchronization on a random connection. It can be used to test receiving data on your webhooks.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


912
913
914
915
 
# File 'lib/budgea_client/api/administration_api.rb', line 912

def test_sync_post(opts = {})
  test_sync_post_with_http_info(opts)
  nil
end

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

Test synchronization on a random connection. It can be used to test receiving data on your webhooks.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/budgea_client/api/administration_api.rb', line 921

def test_sync_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.test_sync_post ...'
  end
  # resource path
  local_var_path = '/test/sync'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#test_webhooks_post(opts = {}) ⇒ nil

Test synchronization on a random connection. It can be used to test receiving data on your webhooks.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


959
960
961
962
 
# File 'lib/budgea_client/api/administration_api.rb', line 959

def test_webhooks_post(opts = {})
  test_webhooks_post_with_http_info(opts)
  nil
end

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

Test synchronization on a random connection. It can be used to test receiving data on your webhooks.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'lib/budgea_client/api/administration_api.rb', line 968

def test_webhooks_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.test_webhooks_post ...'
  end
  # resource path
  local_var_path = '/test/webhooks'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_auth_delete(opts = {}) ⇒ AuthProvider

Deletes all webhook authentication types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1007
1008
1009
1010
 
# File 'lib/budgea_client/api/administration_api.rb', line 1007

def webhooks_auth_delete(opts = {})
  data, _status_code, _headers = webhooks_auth_delete_with_http_info(opts)
  data
end

#webhooks_auth_delete_with_http_info(opts = {}) ⇒ Array<(AuthProvider, Fixnum, Hash)>

Deletes all webhook authentication types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    AuthProvider data, response status code and response headers



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'lib/budgea_client/api/administration_api.rb', line 1017

def webhooks_auth_delete_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_auth_delete ...'
  end
  # resource path
  local_var_path = '/webhooks/auth'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_auth_get(opts = {}) ⇒ InlineResponse20041

Get webhooks authentication types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1058
1059
1060
1061
 
# File 'lib/budgea_client/api/administration_api.rb', line 1058

def webhooks_auth_get(opts = {})
  data, _status_code, _headers = webhooks_auth_get_with_http_info(opts)
  data
end

#webhooks_auth_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20041, Fixnum, Hash)>

Get webhooks authentication types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20041 data, response status code and response headers



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
 
# File 'lib/budgea_client/api/administration_api.rb', line 1068

def webhooks_auth_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_auth_get ...'
  end
  # resource path
  local_var_path = '/webhooks/auth'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_auth_id_auth_delete(id_auth, opts = {}) ⇒ AuthProvider

Deletes the webhook authentication type Updates the deleted field with the date of the deletion

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1110
1111
1112
1113
 
# File 'lib/budgea_client/api/administration_api.rb', line 1110

def webhooks_auth_id_auth_delete(id_auth, opts = {})
  data, _status_code, _headers = webhooks_auth_id_auth_delete_with_http_info(id_auth, opts)
  data
end

#webhooks_auth_id_auth_delete_with_http_info(id_auth, opts = {}) ⇒ Array<(AuthProvider, Fixnum, Hash)>

Deletes the webhook authentication type Updates the deleted field with the date of the deletion&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    AuthProvider data, response status code and response headers



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
 
# File 'lib/budgea_client/api/administration_api.rb', line 1121

def webhooks_auth_id_auth_delete_with_http_info(id_auth, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_auth_id_auth_delete ...'
  end
  # verify the required parameter 'id_auth' is set
  if @api_client.config.client_side_validation && id_auth.nil?
    fail ArgumentError, "Missing the required parameter 'id_auth' when calling AdministrationApi.webhooks_auth_id_auth_delete"
  end
  # resource path
  local_var_path = '/webhooks/auth/{id_auth}'.sub('{' + 'id_auth' + '}', id_auth.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_auth_id_auth_post(id_auth, type, name, opts = {}) ⇒ AuthProvider

Updates the webhook authentication type

Parameters:

  • id_auth
  • type —

    The type of the authentication process (oauth, certificate, token, etc…)

  • name —

    The name of the authentication process to differentiate

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

    the optional parameters

Options Hash (opts):

  • :config (String) —

    The authentication process configuration. A dict containing either the certificate

  • :expand (String)

Returns:



1170
1171
1172
1173
 
# File 'lib/budgea_client/api/administration_api.rb', line 1170

def webhooks_auth_id_auth_post(id_auth, type, name, opts = {})
  data, _status_code, _headers = webhooks_auth_id_auth_post_with_http_info(id_auth, type, name, opts)
  data
end

#webhooks_auth_id_auth_post_with_http_info(id_auth, type, name, opts = {}) ⇒ Array<(AuthProvider, Fixnum, Hash)>

Updates the webhook authentication type

Parameters:

  • id_auth
  • type —

    The type of the authentication process (oauth, certificate, token, etc…)

  • name —

    The name of the authentication process to differentiate

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

    the optional parameters

Options Hash (opts):

  • :config (String) —

    The authentication process configuration. A dict containing either the certificate

  • :expand (String)

Returns:

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

    AuthProvider data, response status code and response headers



1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'lib/budgea_client/api/administration_api.rb', line 1184

def webhooks_auth_id_auth_post_with_http_info(id_auth, type, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_auth_id_auth_post ...'
  end
  # verify the required parameter 'id_auth' is set
  if @api_client.config.client_side_validation && id_auth.nil?
    fail ArgumentError, "Missing the required parameter 'id_auth' when calling AdministrationApi.webhooks_auth_id_auth_post"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling AdministrationApi.webhooks_auth_id_auth_post"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling AdministrationApi.webhooks_auth_id_auth_post"
  end
  # resource path
  local_var_path = '/webhooks/auth/{id_auth}'.sub('{' + 'id_auth' + '}', id_auth.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['type'] = type
  form_params['name'] = name
  form_params['config'] = opts[:'config'] if !opts[:'config'].nil?

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

#webhooks_auth_id_auth_put(id_auth, type, name, opts = {}) ⇒ AuthProvider

Updates the webhook authentication type

Parameters:

  • id_auth
  • type —

    The type of the authentication process (oauth, certificate, token, etc…)

  • name —

    The name of the authentication process to differentiate

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

    the optional parameters

Options Hash (opts):

  • :config (String) —

    The authentication process configuration. A dict containt either the certificate

  • :expand (String)

Returns:



1244
1245
1246
1247
 
# File 'lib/budgea_client/api/administration_api.rb', line 1244

def webhooks_auth_id_auth_put(id_auth, type, name, opts = {})
  data, _status_code, _headers = webhooks_auth_id_auth_put_with_http_info(id_auth, type, name, opts)
  data
end

#webhooks_auth_id_auth_put_with_http_info(id_auth, type, name, opts = {}) ⇒ Array<(AuthProvider, Fixnum, Hash)>

Updates the webhook authentication type

Parameters:

  • id_auth
  • type —

    The type of the authentication process (oauth, certificate, token, etc…)

  • name —

    The name of the authentication process to differentiate

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

    the optional parameters

Options Hash (opts):

  • :config (String) —

    The authentication process configuration. A dict containt either the certificate

  • :expand (String)

Returns:

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

    AuthProvider data, response status code and response headers



1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'lib/budgea_client/api/administration_api.rb', line 1258

def webhooks_auth_id_auth_put_with_http_info(id_auth, type, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_auth_id_auth_put ...'
  end
  # verify the required parameter 'id_auth' is set
  if @api_client.config.client_side_validation && id_auth.nil?
    fail ArgumentError, "Missing the required parameter 'id_auth' when calling AdministrationApi.webhooks_auth_id_auth_put"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling AdministrationApi.webhooks_auth_id_auth_put"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling AdministrationApi.webhooks_auth_id_auth_put"
  end
  # resource path
  local_var_path = '/webhooks/auth/{id_auth}'.sub('{' + 'id_auth' + '}', id_auth.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['type'] = type
  form_params['name'] = name
  form_params['config'] = opts[:'config'] if !opts[:'config'].nil?

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

#webhooks_auth_post(type, name, opts = {}) ⇒ AuthProvider

Adds a new webhook authentication type

Parameters:

  • type —

    The type of the authentication process (oauth, certificate, token, etc…)

  • name —

    The name of the authentication process to differentiate

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

    the optional parameters

Options Hash (opts):

  • :config (String) —

    The authentication process configuration. A dict contains either the certificate

  • :expand (String)

Returns:



1317
1318
1319
1320
 
# File 'lib/budgea_client/api/administration_api.rb', line 1317

def webhooks_auth_post(type, name, opts = {})
  data, _status_code, _headers = webhooks_auth_post_with_http_info(type, name, opts)
  data
end

#webhooks_auth_post_with_http_info(type, name, opts = {}) ⇒ Array<(AuthProvider, Fixnum, Hash)>

Adds a new webhook authentication type

Parameters:

  • type —

    The type of the authentication process (oauth, certificate, token, etc…)

  • name —

    The name of the authentication process to differentiate

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

    the optional parameters

Options Hash (opts):

  • :config (String) —

    The authentication process configuration. A dict contains either the certificate

  • :expand (String)

Returns:

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

    AuthProvider data, response status code and response headers



1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
 
# File 'lib/budgea_client/api/administration_api.rb', line 1330

def webhooks_auth_post_with_http_info(type, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_auth_post ...'
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling AdministrationApi.webhooks_auth_post"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling AdministrationApi.webhooks_auth_post"
  end
  # resource path
  local_var_path = '/webhooks/auth'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['type'] = type
  form_params['name'] = name
  form_params['config'] = opts[:'config'] if !opts[:'config'].nil?

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

#webhooks_delete(opts = {}) ⇒ Webhook

Deletes all webhooks Updates the deleted field with the date of the deletion

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1382
1383
1384
1385
 
# File 'lib/budgea_client/api/administration_api.rb', line 1382

def webhooks_delete(opts = {})
  data, _status_code, _headers = webhooks_delete_with_http_info(opts)
  data
end

#webhooks_delete_with_http_info(opts = {}) ⇒ Array<(Webhook, Fixnum, Hash)>

Deletes all webhooks Updates the deleted field with the date of the deletion&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Webhook data, response status code and response headers



1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
 
# File 'lib/budgea_client/api/administration_api.rb', line 1392

def webhooks_delete_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_delete ...'
  end
  # resource path
  local_var_path = '/webhooks'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_get(opts = {}) ⇒ InlineResponse20040

Get webhooks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1433
1434
1435
1436
 
# File 'lib/budgea_client/api/administration_api.rb', line 1433

def webhooks_get(opts = {})
  data, _status_code, _headers = webhooks_get_with_http_info(opts)
  data
end

#webhooks_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20040, Fixnum, Hash)>

Get webhooks

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20040 data, response status code and response headers



1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
 
# File 'lib/budgea_client/api/administration_api.rb', line 1443

def webhooks_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_get ...'
  end
  # resource path
  local_var_path = '/webhooks'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_id_webhook_add_to_data_delete(id_webhook, opts = {}) ⇒ Webhook

delete all entries

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1485
1486
1487
1488
 
# File 'lib/budgea_client/api/administration_api.rb', line 1485

def webhooks_id_webhook_add_to_data_delete(id_webhook, opts = {})
  data, _status_code, _headers = webhooks_id_webhook_add_to_data_delete_with_http_info(id_webhook, opts)
  data
end

#webhooks_id_webhook_add_to_data_delete_with_http_info(id_webhook, opts = {}) ⇒ Array<(Webhook, Fixnum, Hash)>

delete all entries

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Webhook data, response status code and response headers



1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
 
# File 'lib/budgea_client/api/administration_api.rb', line 1496

def webhooks_id_webhook_add_to_data_delete_with_http_info(id_webhook, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_id_webhook_add_to_data_delete ...'
  end
  # verify the required parameter 'id_webhook' is set
  if @api_client.config.client_side_validation && id_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'id_webhook' when calling AdministrationApi.webhooks_id_webhook_add_to_data_delete"
  end
  # resource path
  local_var_path = '/webhooks/{id_webhook}/add_to_data'.sub('{' + 'id_webhook' + '}', id_webhook.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_id_webhook_add_to_data_get(id_webhook, opts = {}) ⇒ InlineResponse20040

retrieve the list of the value to add in webhooks when sending the requested webhook

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1542
1543
1544
1545
 
# File 'lib/budgea_client/api/administration_api.rb', line 1542

def webhooks_id_webhook_add_to_data_get(id_webhook, opts = {})
  data, _status_code, _headers = webhooks_id_webhook_add_to_data_get_with_http_info(id_webhook, opts)
  data
end

#webhooks_id_webhook_add_to_data_get_with_http_info(id_webhook, opts = {}) ⇒ Array<(InlineResponse20040, Fixnum, Hash)>

retrieve the list of the value to add in webhooks when sending the requested webhook

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20040 data, response status code and response headers



1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
 
# File 'lib/budgea_client/api/administration_api.rb', line 1553

def webhooks_id_webhook_add_to_data_get_with_http_info(id_webhook, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_id_webhook_add_to_data_get ...'
  end
  # verify the required parameter 'id_webhook' is set
  if @api_client.config.client_side_validation && id_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'id_webhook' when calling AdministrationApi.webhooks_id_webhook_add_to_data_get"
  end
  # resource path
  local_var_path = '/webhooks/{id_webhook}/add_to_data'.sub('{' + 'id_webhook' + '}', id_webhook.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_id_webhook_add_to_data_key_delete(id_webhook, key, opts = {}) ⇒ Webhook

delete the requested entry

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1600
1601
1602
1603
 
# File 'lib/budgea_client/api/administration_api.rb', line 1600

def webhooks_id_webhook_add_to_data_key_delete(id_webhook, key, opts = {})
  data, _status_code, _headers = webhooks_id_webhook_add_to_data_key_delete_with_http_info(id_webhook, key, opts)
  data
end

#webhooks_id_webhook_add_to_data_key_delete_with_http_info(id_webhook, key, opts = {}) ⇒ Array<(Webhook, Fixnum, Hash)>

delete the requested entry

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Webhook data, response status code and response headers



1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
 
# File 'lib/budgea_client/api/administration_api.rb', line 1612

def webhooks_id_webhook_add_to_data_key_delete_with_http_info(id_webhook, key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_id_webhook_add_to_data_key_delete ...'
  end
  # verify the required parameter 'id_webhook' is set
  if @api_client.config.client_side_validation && id_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'id_webhook' when calling AdministrationApi.webhooks_id_webhook_add_to_data_key_delete"
  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 AdministrationApi.webhooks_id_webhook_add_to_data_key_delete"
  end
  # resource path
  local_var_path = '/webhooks/{id_webhook}/add_to_data/{key}'.sub('{' + 'id_webhook' + '}', id_webhook.to_s).sub('{' + 'key' + '}', key.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_id_webhook_add_to_data_key_get(id_webhook, key, opts = {}) ⇒ Webhook

retrieve the value to add in the requested webhook for the requested name

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1663
1664
1665
1666
 
# File 'lib/budgea_client/api/administration_api.rb', line 1663

def webhooks_id_webhook_add_to_data_key_get(id_webhook, key, opts = {})
  data, _status_code, _headers = webhooks_id_webhook_add_to_data_key_get_with_http_info(id_webhook, key, opts)
  data
end

#webhooks_id_webhook_add_to_data_key_get_with_http_info(id_webhook, key, opts = {}) ⇒ Array<(Webhook, Fixnum, Hash)>

retrieve the value to add in the requested webhook for the requested name

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Webhook data, response status code and response headers



1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
 
# File 'lib/budgea_client/api/administration_api.rb', line 1675

def webhooks_id_webhook_add_to_data_key_get_with_http_info(id_webhook, key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_id_webhook_add_to_data_key_get ...'
  end
  # verify the required parameter 'id_webhook' is set
  if @api_client.config.client_side_validation && id_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'id_webhook' when calling AdministrationApi.webhooks_id_webhook_add_to_data_key_get"
  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 AdministrationApi.webhooks_id_webhook_add_to_data_key_get"
  end
  # resource path
  local_var_path = '/webhooks/{id_webhook}/add_to_data/{key}'.sub('{' + 'id_webhook' + '}', id_webhook.to_s).sub('{' + 'key' + '}', key.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_id_webhook_add_to_data_key_post(id_webhook, key, opts = {}) ⇒ Webhook

upate the requested field to store in user config when calling the endpoint For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1726
1727
1728
1729
 
# File 'lib/budgea_client/api/administration_api.rb', line 1726

def webhooks_id_webhook_add_to_data_key_post(id_webhook, key, opts = {})
  data, _status_code, _headers = webhooks_id_webhook_add_to_data_key_post_with_http_info(id_webhook, key, opts)
  data
end

#webhooks_id_webhook_add_to_data_key_post_with_http_info(id_webhook, key, opts = {}) ⇒ Array<(Webhook, Fixnum, Hash)>

upate the requested field to store in user config when calling the endpoint For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Webhook data, response status code and response headers



1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'lib/budgea_client/api/administration_api.rb', line 1738

def webhooks_id_webhook_add_to_data_key_post_with_http_info(id_webhook, key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_id_webhook_add_to_data_key_post ...'
  end
  # verify the required parameter 'id_webhook' is set
  if @api_client.config.client_side_validation && id_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'id_webhook' when calling AdministrationApi.webhooks_id_webhook_add_to_data_key_post"
  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 AdministrationApi.webhooks_id_webhook_add_to_data_key_post"
  end
  # resource path
  local_var_path = '/webhooks/{id_webhook}/add_to_data/{key}'.sub('{' + 'id_webhook' + '}', id_webhook.to_s).sub('{' + 'key' + '}', key.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_id_webhook_add_to_data_post(id_webhook, opts = {}) ⇒ Webhook

Setup a field to store in user config when calling the endpoint For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1788
1789
1790
1791
 
# File 'lib/budgea_client/api/administration_api.rb', line 1788

def webhooks_id_webhook_add_to_data_post(id_webhook, opts = {})
  data, _status_code, _headers = webhooks_id_webhook_add_to_data_post_with_http_info(id_webhook, opts)
  data
end

#webhooks_id_webhook_add_to_data_post_with_http_info(id_webhook, opts = {}) ⇒ Array<(Webhook, Fixnum, Hash)>

Setup a field to store in user config when calling the endpoint For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Webhook data, response status code and response headers



1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
 
# File 'lib/budgea_client/api/administration_api.rb', line 1799

def webhooks_id_webhook_add_to_data_post_with_http_info(id_webhook, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_id_webhook_add_to_data_post ...'
  end
  # verify the required parameter 'id_webhook' is set
  if @api_client.config.client_side_validation && id_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'id_webhook' when calling AdministrationApi.webhooks_id_webhook_add_to_data_post"
  end
  # resource path
  local_var_path = '/webhooks/{id_webhook}/add_to_data'.sub('{' + 'id_webhook' + '}', id_webhook.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_id_webhook_delete(id_webhook, opts = {}) ⇒ Webhook

Deletes a webhook Updates the deleted field with the date of the deletion

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1845
1846
1847
1848
 
# File 'lib/budgea_client/api/administration_api.rb', line 1845

def webhooks_id_webhook_delete(id_webhook, opts = {})
  data, _status_code, _headers = webhooks_id_webhook_delete_with_http_info(id_webhook, opts)
  data
end

#webhooks_id_webhook_delete_with_http_info(id_webhook, opts = {}) ⇒ Array<(Webhook, Fixnum, Hash)>

Deletes a webhook Updates the deleted field with the date of the deletion&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Webhook data, response status code and response headers



1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/budgea_client/api/administration_api.rb', line 1856

def webhooks_id_webhook_delete_with_http_info(id_webhook, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_id_webhook_delete ...'
  end
  # verify the required parameter 'id_webhook' is set
  if @api_client.config.client_side_validation && id_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'id_webhook' when calling AdministrationApi.webhooks_id_webhook_delete"
  end
  # resource path
  local_var_path = '/webhooks/{id_webhook}'.sub('{' + 'id_webhook' + '}', id_webhook.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_id_webhook_logs_get(id_webhook, opts = {}) ⇒ InlineResponse20042

Get webhooks logs. Get logs of the webhooks.
By default, it selects logs for the last month. You can use "min_date" and "max_date" to change boundary dates.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id_user (Integer) —

    limit number of results to this user

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :expand (String)

Returns:



1907
1908
1909
1910
 
# File 'lib/budgea_client/api/administration_api.rb', line 1907

def webhooks_id_webhook_logs_get(id_webhook, opts = {})
  data, _status_code, _headers = webhooks_id_webhook_logs_get_with_http_info(id_webhook, opts)
  data
end

#webhooks_id_webhook_logs_get_with_http_info(id_webhook, opts = {}) ⇒ Array<(InlineResponse20042, Fixnum, Hash)>

Get webhooks logs. Get logs of the webhooks.&lt;br&gt;&lt;br&gt;By default, it selects logs for the last month. You can use &quot;min_date&quot; and &quot;max_date&quot; to change boundary dates.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id_user (Integer) —

    limit number of results to this user

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :expand (String)

Returns:

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

    InlineResponse20042 data, response status code and response headers



1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'lib/budgea_client/api/administration_api.rb', line 1923

def webhooks_id_webhook_logs_get_with_http_info(id_webhook, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_id_webhook_logs_get ...'
  end
  # verify the required parameter 'id_webhook' is set
  if @api_client.config.client_side_validation && id_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'id_webhook' when calling AdministrationApi.webhooks_id_webhook_logs_get"
  end
  # resource path
  local_var_path = '/webhooks/{id_webhook}/logs'.sub('{' + 'id_webhook' + '}', id_webhook.to_s)

  # query parameters
  query_params = {}
  query_params[:'id_user'] = opts[:'id_user'] if !opts[:'id_user'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#webhooks_id_webhook_post(id_webhook, opts = {}) ⇒ Webhook

Updates a webhook

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :deleted (String) —

    a date to delete the webhook or &#39;null&#39; to enable it

  • :id_user (Integer) —

    The user ID to associate with the webhook

  • :id_service (Integer) —

    The service ID to associate with the webhook

  • :id_auth (Integer) —

    The webhook authentication process to use

  • :url (String) —

    The webhook callback url

  • :event (String) —

    The webhook event

  • :expand (String)

Returns:



1980
1981
1982
1983
 
# File 'lib/budgea_client/api/administration_api.rb', line 1980

def webhooks_id_webhook_post(id_webhook, opts = {})
  data, _status_code, _headers = webhooks_id_webhook_post_with_http_info(id_webhook, opts)
  data
end

#webhooks_id_webhook_post_with_http_info(id_webhook, opts = {}) ⇒ Array<(Webhook, Fixnum, Hash)>

Updates a webhook

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :deleted (String) —

    a date to delete the webhook or &#39;null&#39; to enable it

  • :id_user (Integer) —

    The user ID to associate with the webhook

  • :id_service (Integer) —

    The service ID to associate with the webhook

  • :id_auth (Integer) —

    The webhook authentication process to use

  • :url (String) —

    The webhook callback url

  • :event (String) —

    The webhook event

  • :expand (String)

Returns:

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

    Webhook data, response status code and response headers



1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
 
# File 'lib/budgea_client/api/administration_api.rb', line 1997

def webhooks_id_webhook_post_with_http_info(id_webhook, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_id_webhook_post ...'
  end
  # verify the required parameter 'id_webhook' is set
  if @api_client.config.client_side_validation && id_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'id_webhook' when calling AdministrationApi.webhooks_id_webhook_post"
  end
  # resource path
  local_var_path = '/webhooks/{id_webhook}'.sub('{' + 'id_webhook' + '}', id_webhook.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['deleted'] = opts[:'deleted'] if !opts[:'deleted'].nil?
  form_params['id_user'] = opts[:'id_user'] if !opts[:'id_user'].nil?
  form_params['id_service'] = opts[:'id_service'] if !opts[:'id_service'].nil?
  form_params['id_auth'] = opts[:'id_auth'] if !opts[:'id_auth'].nil?
  form_params['url'] = opts[:'url'] if !opts[:'url'].nil?
  form_params['event'] = opts[:'event'] if !opts[:'event'].nil?

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

#webhooks_id_webhook_put(id_webhook, opts = {}) ⇒ Webhook

Updates a webhook

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :deleted (String) —

    a date to delete the webhook or &#39;null&#39; to enable it

  • :id_user (Integer) —

    The user ID to associate with the webhook

  • :id_service (Integer) —

    The service ID to associate with the webhook

  • :id_auth (Integer) —

    The webhook authentication process to use

  • :url (String) —

    The webhook callback url

  • :event (String) —

    The webhook event

  • :expand (String)

Returns:



2055
2056
2057
2058
 
# File 'lib/budgea_client/api/administration_api.rb', line 2055

def webhooks_id_webhook_put(id_webhook, opts = {})
  data, _status_code, _headers = webhooks_id_webhook_put_with_http_info(id_webhook, opts)
  data
end

#webhooks_id_webhook_put_with_http_info(id_webhook, opts = {}) ⇒ Array<(Webhook, Fixnum, Hash)>

Updates a webhook

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :deleted (String) —

    a date to delete the webhook or &#39;null&#39; to enable it

  • :id_user (Integer) —

    The user ID to associate with the webhook

  • :id_service (Integer) —

    The service ID to associate with the webhook

  • :id_auth (Integer) —

    The webhook authentication process to use

  • :url (String) —

    The webhook callback url

  • :event (String) —

    The webhook event

  • :expand (String)

Returns:

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

    Webhook data, response status code and response headers



2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
 
# File 'lib/budgea_client/api/administration_api.rb', line 2072

def webhooks_id_webhook_put_with_http_info(id_webhook, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_id_webhook_put ...'
  end
  # verify the required parameter 'id_webhook' is set
  if @api_client.config.client_side_validation && id_webhook.nil?
    fail ArgumentError, "Missing the required parameter 'id_webhook' when calling AdministrationApi.webhooks_id_webhook_put"
  end
  # resource path
  local_var_path = '/webhooks/{id_webhook}'.sub('{' + 'id_webhook' + '}', id_webhook.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['deleted'] = opts[:'deleted'] if !opts[:'deleted'].nil?
  form_params['id_user'] = opts[:'id_user'] if !opts[:'id_user'].nil?
  form_params['id_service'] = opts[:'id_service'] if !opts[:'id_service'].nil?
  form_params['id_auth'] = opts[:'id_auth'] if !opts[:'id_auth'].nil?
  form_params['url'] = opts[:'url'] if !opts[:'url'].nil?
  form_params['event'] = opts[:'event'] if !opts[:'event'].nil?

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

#webhooks_post(opts = {}) ⇒ Webhook

Adds a new webhook

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id_user (Integer) —

    The user ID to associate with the webhook

  • :id_service (Integer) —

    The service ID to associate with the webhook

  • :id_auth (String) —

    The webhook authentication process to use (its ID or its name)

  • :url (String) —

    The webhook callback url

  • :event (String) —

    The webhook event

  • :params (String) —

    The webhook parameters as an object with three keys: type, key and value

  • :expand (String)

Returns:



2129
2130
2131
2132
 
# File 'lib/budgea_client/api/administration_api.rb', line 2129

def webhooks_post(opts = {})
  data, _status_code, _headers = webhooks_post_with_http_info(opts)
  data
end

#webhooks_post_with_http_info(opts = {}) ⇒ Array<(Webhook, Fixnum, Hash)>

Adds a new webhook

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id_user (Integer) —

    The user ID to associate with the webhook

  • :id_service (Integer) —

    The service ID to associate with the webhook

  • :id_auth (String) —

    The webhook authentication process to use (its ID or its name)

  • :url (String) —

    The webhook callback url

  • :event (String) —

    The webhook event

  • :params (String) —

    The webhook parameters as an object with three keys: type, key and value

  • :expand (String)

Returns:

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

    Webhook data, response status code and response headers



2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
 
# File 'lib/budgea_client/api/administration_api.rb', line 2145

def webhooks_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdministrationApi.webhooks_post ...'
  end
  # resource path
  local_var_path = '/webhooks'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_user'] = opts[:'id_user'] if !opts[:'id_user'].nil?
  form_params['id_service'] = opts[:'id_service'] if !opts[:'id_service'].nil?
  form_params['id_auth'] = opts[:'id_auth'] if !opts[:'id_auth'].nil?
  form_params['url'] = opts[:'url'] if !opts[:'url'].nil?
  form_params['event'] = opts[:'event'] if !opts[:'event'].nil?
  form_params['params'] = opts[:'params'] if !opts[:'params'].nil?

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