budgea_client 4.0.3 → 5.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +50 -5
- data/budgea_openapi.json +1888 -383
- data/docs/Account.md +2 -0
- data/docs/AccountLog.md +1 -0
- data/docs/AdministrationApi.md +366 -55
- data/docs/AuthenticationApi.md +15 -13
- data/docs/BanksApi.md +988 -194
- data/docs/Client.md +1 -1
- data/docs/Connection.md +2 -0
- data/docs/ConnectionLog.md +1 -0
- data/docs/ConnectionSource.md +18 -0
- data/docs/ConnectionsApi.md +618 -25
- data/docs/Connector.md +1 -1
- data/docs/ConnectorSource.md +15 -0
- data/docs/DocumentsApi.md +72 -72
- data/docs/Field.md +1 -0
- data/docs/InlineResponse20011.md +1 -1
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +1 -1
- data/docs/InlineResponse20014.md +1 -1
- data/docs/InlineResponse20015.md +1 -1
- data/docs/InlineResponse20016.md +1 -1
- data/docs/InlineResponse20017.md +1 -1
- data/docs/InlineResponse20018.md +1 -1
- data/docs/InlineResponse20019.md +2 -1
- data/docs/InlineResponse20030.md +1 -1
- data/docs/InlineResponse20031.md +1 -1
- data/docs/InlineResponse20032.md +1 -1
- data/docs/InlineResponse20033.md +1 -1
- data/docs/InlineResponse20034.md +1 -1
- data/docs/InlineResponse20035.md +1 -1
- data/docs/InlineResponse20036.md +1 -1
- data/docs/InlineResponse20037.md +1 -1
- data/docs/InlineResponse20038.md +1 -1
- data/docs/InlineResponse20039.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +9 -0
- data/docs/InlineResponse20042.md +9 -0
- data/docs/OIDCApi.md +3 -3
- data/docs/Order.md +14 -0
- data/docs/PFMApi.md +87 -39
- data/docs/ProvidersApi.md +979 -122
- data/docs/RecipientsApi.md +4 -4
- data/docs/Subscription.md +1 -0
- data/docs/SubscriptionLog.md +15 -0
- data/docs/TermsApi.md +3 -3
- data/docs/Transaction.md +1 -0
- data/docs/Transfer.md +5 -1
- data/docs/TransferApi.md +77 -0
- data/docs/TransfersApi.md +39 -39
- data/docs/UsersManagementApi.md +13 -13
- data/docs/WealthApi.md +24 -24
- data/lib/budgea_client.rb +7 -2
- data/lib/budgea_client/api/administration_api.rb +381 -71
- data/lib/budgea_client/api/authentication_api.rb +16 -13
- data/lib/budgea_client/api/banks_api.rb +1034 -211
- data/lib/budgea_client/api/connections_api.rb +648 -30
- data/lib/budgea_client/api/documents_api.rb +85 -85
- data/lib/budgea_client/api/oidc_api.rb +3 -3
- data/lib/budgea_client/api/pfm_api.rb +87 -40
- data/lib/budgea_client/api/providers_api.rb +1045 -151
- data/lib/budgea_client/api/recipients_api.rb +4 -4
- data/lib/budgea_client/api/terms_api.rb +3 -3
- data/lib/budgea_client/api/transfer_api.rb +94 -0
- data/lib/budgea_client/api/transfers_api.rb +39 -39
- data/lib/budgea_client/api/users_management_api.rb +14 -14
- data/lib/budgea_client/api/wealth_api.rb +25 -25
- data/lib/budgea_client/models/account.rb +24 -4
- data/lib/budgea_client/models/account_log.rb +16 -1
- data/lib/budgea_client/models/client.rb +11 -11
- data/lib/budgea_client/models/connection.rb +23 -4
- data/lib/budgea_client/models/connection_log.rb +11 -1
- data/lib/budgea_client/models/connection_source.rb +309 -0
- data/lib/budgea_client/models/connector.rb +18 -15
- data/lib/budgea_client/models/connector_source.rb +273 -0
- data/lib/budgea_client/models/field.rb +14 -4
- data/lib/budgea_client/models/inline_response_200_11.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_12.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_13.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_14.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_15.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_16.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_17.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_18.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_19.rb +21 -11
- data/lib/budgea_client/models/inline_response_200_30.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_31.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_32.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_33.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_34.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_35.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_36.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_37.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_38.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_39.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_40.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_41.rb +200 -0
- data/lib/budgea_client/models/inline_response_200_42.rb +200 -0
- data/lib/budgea_client/models/order.rb +259 -0
- data/lib/budgea_client/models/subscription.rb +11 -1
- data/lib/budgea_client/models/subscription_log.rb +269 -0
- data/lib/budgea_client/models/transaction.rb +11 -1
- data/lib/budgea_client/models/transfer.rb +49 -2
- data/lib/budgea_client/models/user.rb +2 -2
- data/lib/budgea_client/version.rb +1 -1
- data/original_budgea_openapi.json +1980 -351
- data/pkg/budgea_client-2.0.0.gem +0 -0
- data/pkg/budgea_client-3.0.1.gem +0 -0
- data/pkg/budgea_client-4.0.0.gem +0 -0
- data/spec/api/transfer_api_spec.rb +54 -0
- data/spec/models/connection_source_spec.rb +101 -0
- data/spec/models/connector_source_spec.rb +83 -0
- data/spec/models/inline_response_200_41_spec.rb +47 -0
- data/spec/models/inline_response_200_42_spec.rb +47 -0
- data/spec/models/order_spec.rb +77 -0
- data/spec/models/subscription_log_spec.rb +83 -0
- metadata +34 -9
- data/config.yaml +0 -15
- data/pkg/budgea_client-2.0.1.gem +0 -0
- data/pkg/budgea_client-2.0.2.gem +0 -0
- data/pkg/budgea_client-3.0.0.gem +0 -0
- data/pkg/budgea_client-4.0.1.gem +0 -0
- data/pkg/budgea_client-4.0.2.gem +0 -0
data/docs/Account.md
CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**id** | **Integer** | ID of the account |
|
7
7
|
**id_connection** | **Integer** | ID of the related connection | [optional]
|
8
8
|
**id_user** | **Integer** | ID of the related user | [optional]
|
9
|
+
**id_source** | **Integer** | ID of the related connection source | [optional]
|
9
10
|
**id_parent** | **Integer** | Id of the parent account | [optional]
|
10
11
|
**number** | **String** | Account number | [optional]
|
11
12
|
**webid** | **String** | Account webid | [optional]
|
@@ -27,5 +28,6 @@ Name | Type | Description | Notes
|
|
27
28
|
**error** | **String** | If the last update has failed, the error code | [optional]
|
28
29
|
**usage** | **String** | Account usage | [optional]
|
29
30
|
**ownership** | **String** | Relationship between the credentials owner and the account | [optional]
|
31
|
+
**company_name** | **String** | Name of the company holding the employee savings of the account | [optional]
|
30
32
|
|
31
33
|
|
data/docs/AccountLog.md
CHANGED
@@ -3,6 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | ID of the log |
|
6
7
|
**id_account** | **Integer** | ID of the related account |
|
7
8
|
**id_connector** | **Integer** | provider id | [optional]
|
8
9
|
**balance** | **Float** | Balanced recorded |
|
data/docs/AdministrationApi.md
CHANGED
@@ -29,7 +29,12 @@ Method | HTTP request | Description
|
|
29
29
|
[**webhooks_auth_post**](AdministrationApi.md#webhooks_auth_post) | **POST** /webhooks/auth | Adds a new webhook authentication type
|
30
30
|
[**webhooks_delete**](AdministrationApi.md#webhooks_delete) | **DELETE** /webhooks | Deletes all webhooks
|
31
31
|
[**webhooks_get**](AdministrationApi.md#webhooks_get) | **GET** /webhooks | Get webhooks
|
32
|
+
[**webhooks_id_webhook_add_to_data_delete**](AdministrationApi.md#webhooks_id_webhook_add_to_data_delete) | **DELETE** /webhooks/{id_webhook}/add_to_data | delete all entries
|
32
33
|
[**webhooks_id_webhook_add_to_data_get**](AdministrationApi.md#webhooks_id_webhook_add_to_data_get) | **GET** /webhooks/{id_webhook}/add_to_data | retrieve the list of the value to add in webhooks when sending the requested webhook
|
34
|
+
[**webhooks_id_webhook_add_to_data_key_delete**](AdministrationApi.md#webhooks_id_webhook_add_to_data_key_delete) | **DELETE** /webhooks/{id_webhook}/add_to_data/{key} | delete the requested entry
|
35
|
+
[**webhooks_id_webhook_add_to_data_key_get**](AdministrationApi.md#webhooks_id_webhook_add_to_data_key_get) | **GET** /webhooks/{id_webhook}/add_to_data/{key} | retrieve the value to add in the requested webhook for the requested name
|
36
|
+
[**webhooks_id_webhook_add_to_data_key_post**](AdministrationApi.md#webhooks_id_webhook_add_to_data_key_post) | **POST** /webhooks/{id_webhook}/add_to_data/{key} | upate the requested field to store in user config when calling the endpoint
|
37
|
+
[**webhooks_id_webhook_add_to_data_post**](AdministrationApi.md#webhooks_id_webhook_add_to_data_post) | **POST** /webhooks/{id_webhook}/add_to_data | Setup a field to store in user config when calling the endpoint
|
33
38
|
[**webhooks_id_webhook_delete**](AdministrationApi.md#webhooks_id_webhook_delete) | **DELETE** /webhooks/{id_webhook} | Deletes a webhook
|
34
39
|
[**webhooks_id_webhook_logs_get**](AdministrationApi.md#webhooks_id_webhook_logs_get) | **GET** /webhooks/{id_webhook}/logs | Get webhooks logs.
|
35
40
|
[**webhooks_id_webhook_post**](AdministrationApi.md#webhooks_id_webhook_post) | **POST** /webhooks/{id_webhook} | Updates a webhook
|
@@ -38,7 +43,7 @@ Method | HTTP request | Description
|
|
38
43
|
|
39
44
|
|
40
45
|
# **clients_get**
|
41
|
-
>
|
46
|
+
> InlineResponse20013 clients_get(opts)
|
42
47
|
|
43
48
|
List clients
|
44
49
|
|
@@ -79,7 +84,7 @@ Name | Type | Description | Notes
|
|
79
84
|
|
80
85
|
### Return type
|
81
86
|
|
82
|
-
[**
|
87
|
+
[**InlineResponse20013**](InlineResponse20013.md)
|
83
88
|
|
84
89
|
### Authorization
|
85
90
|
|
@@ -87,7 +92,7 @@ Name | Type | Description | Notes
|
|
87
92
|
|
88
93
|
### HTTP request headers
|
89
94
|
|
90
|
-
- **Content-Type**: application/
|
95
|
+
- **Content-Type**: application/json, multipart/form-data
|
91
96
|
- **Accept**: application/json
|
92
97
|
|
93
98
|
|
@@ -145,7 +150,7 @@ Name | Type | Description | Notes
|
|
145
150
|
|
146
151
|
### HTTP request headers
|
147
152
|
|
148
|
-
- **Content-Type**: application/
|
153
|
+
- **Content-Type**: application/json, multipart/form-data
|
149
154
|
- **Accept**: application/json
|
150
155
|
|
151
156
|
|
@@ -155,7 +160,7 @@ Name | Type | Description | Notes
|
|
155
160
|
|
156
161
|
Get information about a client
|
157
162
|
|
158
|
-
If you use the manage_token or a configuration token, you will get also the
|
163
|
+
If you use the manage_token or a configuration token, you will get also the client secret.<br><br>
|
159
164
|
|
160
165
|
### Example
|
161
166
|
```ruby
|
@@ -203,7 +208,7 @@ Name | Type | Description | Notes
|
|
203
208
|
|
204
209
|
### HTTP request headers
|
205
210
|
|
206
|
-
- **Content-Type**: application/
|
211
|
+
- **Content-Type**: application/json, multipart/form-data
|
207
212
|
- **Accept**: application/json
|
208
213
|
|
209
214
|
|
@@ -261,7 +266,7 @@ Name | Type | Description | Notes
|
|
261
266
|
|
262
267
|
### HTTP request headers
|
263
268
|
|
264
|
-
- **Content-Type**: application/
|
269
|
+
- **Content-Type**: application/json, multipart/form-data
|
265
270
|
- **Accept**: application/json
|
266
271
|
|
267
272
|
|
@@ -319,7 +324,7 @@ Name | Type | Description | Notes
|
|
319
324
|
|
320
325
|
### HTTP request headers
|
321
326
|
|
322
|
-
- **Content-Type**: application/
|
327
|
+
- **Content-Type**: application/json, multipart/form-data
|
323
328
|
- **Accept**: application/json
|
324
329
|
|
325
330
|
|
@@ -351,7 +356,7 @@ opts = {
|
|
351
356
|
generate_keys: true, # 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)
|
352
357
|
name: 'name_example', # String | name of client
|
353
358
|
secret: true, # BOOLEAN | reset the secret
|
354
|
-
|
359
|
+
redirect_uris: ['redirect_uris_example'], # Array<String> | list of allowed redirect uris
|
355
360
|
primary_color: 'primary_color_example', # String | hexadecimal code of the client primary color (e.g F45B9A)
|
356
361
|
secondary_color: 'secondary_color_example', # String | hexadecimal code of the client secondary color (e.g F45B9A)
|
357
362
|
description: 'description_example', # String | text to display as a default description
|
@@ -380,7 +385,7 @@ Name | Type | Description | Notes
|
|
380
385
|
**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) | [optional]
|
381
386
|
**name** | **String**| name of client | [optional]
|
382
387
|
**secret** | **BOOLEAN**| reset the secret | [optional]
|
383
|
-
**
|
388
|
+
**redirect_uris** | [**Array<String>**](String.md)| list of allowed redirect uris | [optional]
|
384
389
|
**primary_color** | **String**| hexadecimal code of the client primary color (e.g F45B9A) | [optional]
|
385
390
|
**secondary_color** | **String**| hexadecimal code of the client secondary color (e.g F45B9A) | [optional]
|
386
391
|
**description** | **String**| text to display as a default description | [optional]
|
@@ -401,7 +406,7 @@ Name | Type | Description | Notes
|
|
401
406
|
|
402
407
|
### HTTP request headers
|
403
408
|
|
404
|
-
- **Content-Type**: application/
|
409
|
+
- **Content-Type**: application/json, multipart/form-data
|
405
410
|
- **Accept**: application/json
|
406
411
|
|
407
412
|
|
@@ -430,7 +435,7 @@ api_instance = BudgeaClient::AdministrationApi.new
|
|
430
435
|
opts = {
|
431
436
|
generate_keys: true, # BOOLEAN | if True, generate a rsa pair of keys so the client can be used to generate jwt user tokens (default: False)
|
432
437
|
name: 'name_example', # String | name of client
|
433
|
-
|
438
|
+
redirect_uris: ['redirect_uris_example'], # Array<String> | list of allowed redirect uris
|
434
439
|
config: 'config_example', # String | custom config about the client
|
435
440
|
expand: 'expand_example' # String |
|
436
441
|
}
|
@@ -450,7 +455,7 @@ Name | Type | Description | Notes
|
|
450
455
|
------------- | ------------- | ------------- | -------------
|
451
456
|
**generate_keys** | **BOOLEAN**| if True, generate a rsa pair of keys so the client can be used to generate jwt user tokens (default: False) | [optional]
|
452
457
|
**name** | **String**| name of client | [optional]
|
453
|
-
**
|
458
|
+
**redirect_uris** | [**Array<String>**](String.md)| list of allowed redirect uris | [optional]
|
454
459
|
**config** | **String**| custom config about the client | [optional]
|
455
460
|
**expand** | **String**| | [optional]
|
456
461
|
|
@@ -464,7 +469,7 @@ Name | Type | Description | Notes
|
|
464
469
|
|
465
470
|
### HTTP request headers
|
466
471
|
|
467
|
-
- **Content-Type**: application/
|
472
|
+
- **Content-Type**: application/json, multipart/form-data
|
468
473
|
- **Accept**: application/json
|
469
474
|
|
470
475
|
|
@@ -518,13 +523,13 @@ nil (empty response body)
|
|
518
523
|
|
519
524
|
### HTTP request headers
|
520
525
|
|
521
|
-
- **Content-Type**: application/
|
526
|
+
- **Content-Type**: application/json, multipart/form-data
|
522
527
|
- **Accept**: application/json
|
523
528
|
|
524
529
|
|
525
530
|
|
526
531
|
# **config_logs_get**
|
527
|
-
>
|
532
|
+
> InlineResponse20014 config_logs_get(opts)
|
528
533
|
|
529
534
|
Get configuration change history of the API.
|
530
535
|
|
@@ -573,7 +578,7 @@ Name | Type | Description | Notes
|
|
573
578
|
|
574
579
|
### Return type
|
575
580
|
|
576
|
-
[**
|
581
|
+
[**InlineResponse20014**](InlineResponse20014.md)
|
577
582
|
|
578
583
|
### Authorization
|
579
584
|
|
@@ -581,7 +586,7 @@ Name | Type | Description | Notes
|
|
581
586
|
|
582
587
|
### HTTP request headers
|
583
588
|
|
584
|
-
- **Content-Type**: application/
|
589
|
+
- **Content-Type**: application/json, multipart/form-data
|
585
590
|
- **Accept**: application/json
|
586
591
|
|
587
592
|
|
@@ -636,13 +641,13 @@ Name | Type | Description | Notes
|
|
636
641
|
|
637
642
|
### HTTP request headers
|
638
643
|
|
639
|
-
- **Content-Type**: application/
|
644
|
+
- **Content-Type**: application/json, multipart/form-data
|
640
645
|
- **Accept**: application/json
|
641
646
|
|
642
647
|
|
643
648
|
|
644
649
|
# **merchants_get**
|
645
|
-
>
|
650
|
+
> InlineResponse20013 merchants_get(opts)
|
646
651
|
|
647
652
|
List clients
|
648
653
|
|
@@ -683,7 +688,7 @@ Name | Type | Description | Notes
|
|
683
688
|
|
684
689
|
### Return type
|
685
690
|
|
686
|
-
[**
|
691
|
+
[**InlineResponse20013**](InlineResponse20013.md)
|
687
692
|
|
688
693
|
### Authorization
|
689
694
|
|
@@ -691,7 +696,7 @@ Name | Type | Description | Notes
|
|
691
696
|
|
692
697
|
### HTTP request headers
|
693
698
|
|
694
|
-
- **Content-Type**: application/
|
699
|
+
- **Content-Type**: application/json, multipart/form-data
|
695
700
|
- **Accept**: application/json
|
696
701
|
|
697
702
|
|
@@ -749,7 +754,7 @@ Name | Type | Description | Notes
|
|
749
754
|
|
750
755
|
### HTTP request headers
|
751
756
|
|
752
|
-
- **Content-Type**: application/
|
757
|
+
- **Content-Type**: application/json, multipart/form-data
|
753
758
|
- **Accept**: application/json
|
754
759
|
|
755
760
|
|
@@ -807,13 +812,13 @@ Name | Type | Description | Notes
|
|
807
812
|
|
808
813
|
### HTTP request headers
|
809
814
|
|
810
|
-
- **Content-Type**: application/
|
815
|
+
- **Content-Type**: application/json, multipart/form-data
|
811
816
|
- **Accept**: application/json
|
812
817
|
|
813
818
|
|
814
819
|
|
815
820
|
# **merchants_post**
|
816
|
-
> Client merchants_post(name,
|
821
|
+
> Client merchants_post(name, redirect_uris, iban, opts)
|
817
822
|
|
818
823
|
Create a merchant. Needs a user identified in bearer to be used
|
819
824
|
|
@@ -835,7 +840,7 @@ api_instance = BudgeaClient::AdministrationApi.new
|
|
835
840
|
|
836
841
|
name = 'name_example' # String | name of merchant
|
837
842
|
|
838
|
-
|
843
|
+
redirect_uris = ['redirect_uris_example'] # Array<String> | list of allowed redirect uris
|
839
844
|
|
840
845
|
iban = 'iban_example' # String | payments initiated by this merchant will be done to this IBAN
|
841
846
|
|
@@ -845,7 +850,7 @@ opts = {
|
|
845
850
|
|
846
851
|
begin
|
847
852
|
#Create a merchant. Needs a user identified in bearer to be used
|
848
|
-
result = api_instance.merchants_post(name,
|
853
|
+
result = api_instance.merchants_post(name, redirect_uris, iban, opts)
|
849
854
|
p result
|
850
855
|
rescue BudgeaClient::ApiError => e
|
851
856
|
puts "Exception when calling AdministrationApi->merchants_post: #{e}"
|
@@ -857,7 +862,7 @@ end
|
|
857
862
|
Name | Type | Description | Notes
|
858
863
|
------------- | ------------- | ------------- | -------------
|
859
864
|
**name** | **String**| name of merchant |
|
860
|
-
**
|
865
|
+
**redirect_uris** | [**Array<String>**](String.md)| list of allowed redirect uris |
|
861
866
|
**iban** | **String**| payments initiated by this merchant will be done to this IBAN |
|
862
867
|
**expand** | **String**| | [optional]
|
863
868
|
|
@@ -871,7 +876,7 @@ Name | Type | Description | Notes
|
|
871
876
|
|
872
877
|
### HTTP request headers
|
873
878
|
|
874
|
-
- **Content-Type**: application/
|
879
|
+
- **Content-Type**: application/json, multipart/form-data
|
875
880
|
- **Accept**: application/json
|
876
881
|
|
877
882
|
|
@@ -925,7 +930,7 @@ nil (empty response body)
|
|
925
930
|
|
926
931
|
### HTTP request headers
|
927
932
|
|
928
|
-
- **Content-Type**: application/
|
933
|
+
- **Content-Type**: application/json, multipart/form-data
|
929
934
|
- **Accept**: application/json
|
930
935
|
|
931
936
|
|
@@ -972,7 +977,7 @@ nil (empty response body)
|
|
972
977
|
|
973
978
|
### HTTP request headers
|
974
979
|
|
975
|
-
- **Content-Type**: application/
|
980
|
+
- **Content-Type**: application/json, multipart/form-data
|
976
981
|
- **Accept**: application/json
|
977
982
|
|
978
983
|
|
@@ -1019,7 +1024,7 @@ nil (empty response body)
|
|
1019
1024
|
|
1020
1025
|
### HTTP request headers
|
1021
1026
|
|
1022
|
-
- **Content-Type**: application/
|
1027
|
+
- **Content-Type**: application/json, multipart/form-data
|
1023
1028
|
- **Accept**: application/json
|
1024
1029
|
|
1025
1030
|
|
@@ -1074,13 +1079,13 @@ Name | Type | Description | Notes
|
|
1074
1079
|
|
1075
1080
|
### HTTP request headers
|
1076
1081
|
|
1077
|
-
- **Content-Type**: application/
|
1082
|
+
- **Content-Type**: application/json, multipart/form-data
|
1078
1083
|
- **Accept**: application/json
|
1079
1084
|
|
1080
1085
|
|
1081
1086
|
|
1082
1087
|
# **webhooks_auth_get**
|
1083
|
-
>
|
1088
|
+
> InlineResponse20041 webhooks_auth_get(opts)
|
1084
1089
|
|
1085
1090
|
Get webhooks authentication types
|
1086
1091
|
|
@@ -1121,7 +1126,7 @@ Name | Type | Description | Notes
|
|
1121
1126
|
|
1122
1127
|
### Return type
|
1123
1128
|
|
1124
|
-
[**
|
1129
|
+
[**InlineResponse20041**](InlineResponse20041.md)
|
1125
1130
|
|
1126
1131
|
### Authorization
|
1127
1132
|
|
@@ -1129,7 +1134,7 @@ Name | Type | Description | Notes
|
|
1129
1134
|
|
1130
1135
|
### HTTP request headers
|
1131
1136
|
|
1132
|
-
- **Content-Type**: application/
|
1137
|
+
- **Content-Type**: application/json, multipart/form-data
|
1133
1138
|
- **Accept**: application/json
|
1134
1139
|
|
1135
1140
|
|
@@ -1187,7 +1192,7 @@ Name | Type | Description | Notes
|
|
1187
1192
|
|
1188
1193
|
### HTTP request headers
|
1189
1194
|
|
1190
|
-
- **Content-Type**: application/
|
1195
|
+
- **Content-Type**: application/json, multipart/form-data
|
1191
1196
|
- **Accept**: application/json
|
1192
1197
|
|
1193
1198
|
|
@@ -1253,7 +1258,7 @@ Name | Type | Description | Notes
|
|
1253
1258
|
|
1254
1259
|
### HTTP request headers
|
1255
1260
|
|
1256
|
-
- **Content-Type**: application/
|
1261
|
+
- **Content-Type**: application/json, multipart/form-data
|
1257
1262
|
- **Accept**: application/json
|
1258
1263
|
|
1259
1264
|
|
@@ -1319,7 +1324,7 @@ Name | Type | Description | Notes
|
|
1319
1324
|
|
1320
1325
|
### HTTP request headers
|
1321
1326
|
|
1322
|
-
- **Content-Type**: application/
|
1327
|
+
- **Content-Type**: application/json, multipart/form-data
|
1323
1328
|
- **Accept**: application/json
|
1324
1329
|
|
1325
1330
|
|
@@ -1382,7 +1387,7 @@ Name | Type | Description | Notes
|
|
1382
1387
|
|
1383
1388
|
### HTTP request headers
|
1384
1389
|
|
1385
|
-
- **Content-Type**: application/
|
1390
|
+
- **Content-Type**: application/json, multipart/form-data
|
1386
1391
|
- **Accept**: application/json
|
1387
1392
|
|
1388
1393
|
|
@@ -1437,13 +1442,13 @@ Name | Type | Description | Notes
|
|
1437
1442
|
|
1438
1443
|
### HTTP request headers
|
1439
1444
|
|
1440
|
-
- **Content-Type**: application/
|
1445
|
+
- **Content-Type**: application/json, multipart/form-data
|
1441
1446
|
- **Accept**: application/json
|
1442
1447
|
|
1443
1448
|
|
1444
1449
|
|
1445
1450
|
# **webhooks_get**
|
1446
|
-
>
|
1451
|
+
> InlineResponse20040 webhooks_get(opts)
|
1447
1452
|
|
1448
1453
|
Get webhooks
|
1449
1454
|
|
@@ -1484,7 +1489,7 @@ Name | Type | Description | Notes
|
|
1484
1489
|
|
1485
1490
|
### Return type
|
1486
1491
|
|
1487
|
-
[**
|
1492
|
+
[**InlineResponse20040**](InlineResponse20040.md)
|
1488
1493
|
|
1489
1494
|
### Authorization
|
1490
1495
|
|
@@ -1492,13 +1497,71 @@ Name | Type | Description | Notes
|
|
1492
1497
|
|
1493
1498
|
### HTTP request headers
|
1494
1499
|
|
1495
|
-
- **Content-Type**: application/
|
1500
|
+
- **Content-Type**: application/json, multipart/form-data
|
1501
|
+
- **Accept**: application/json
|
1502
|
+
|
1503
|
+
|
1504
|
+
|
1505
|
+
# **webhooks_id_webhook_add_to_data_delete**
|
1506
|
+
> Webhook webhooks_id_webhook_add_to_data_delete(id_webhook, opts)
|
1507
|
+
|
1508
|
+
delete all entries
|
1509
|
+
|
1510
|
+
|
1511
|
+
|
1512
|
+
### Example
|
1513
|
+
```ruby
|
1514
|
+
# load the gem
|
1515
|
+
require 'budgea_client'
|
1516
|
+
# setup authorization
|
1517
|
+
BudgeaClient.configure do |config|
|
1518
|
+
# Configure API key authorization: api_key
|
1519
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1520
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1521
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1522
|
+
end
|
1523
|
+
|
1524
|
+
api_instance = BudgeaClient::AdministrationApi.new
|
1525
|
+
|
1526
|
+
id_webhook = 56 # Integer |
|
1527
|
+
|
1528
|
+
opts = {
|
1529
|
+
expand: 'expand_example' # String |
|
1530
|
+
}
|
1531
|
+
|
1532
|
+
begin
|
1533
|
+
#delete all entries
|
1534
|
+
result = api_instance.webhooks_id_webhook_add_to_data_delete(id_webhook, opts)
|
1535
|
+
p result
|
1536
|
+
rescue BudgeaClient::ApiError => e
|
1537
|
+
puts "Exception when calling AdministrationApi->webhooks_id_webhook_add_to_data_delete: #{e}"
|
1538
|
+
end
|
1539
|
+
```
|
1540
|
+
|
1541
|
+
### Parameters
|
1542
|
+
|
1543
|
+
Name | Type | Description | Notes
|
1544
|
+
------------- | ------------- | ------------- | -------------
|
1545
|
+
**id_webhook** | **Integer**| |
|
1546
|
+
**expand** | **String**| | [optional]
|
1547
|
+
|
1548
|
+
### Return type
|
1549
|
+
|
1550
|
+
[**Webhook**](Webhook.md)
|
1551
|
+
|
1552
|
+
### Authorization
|
1553
|
+
|
1554
|
+
[api_key](../README.md#api_key)
|
1555
|
+
|
1556
|
+
### HTTP request headers
|
1557
|
+
|
1558
|
+
- **Content-Type**: application/json, multipart/form-data
|
1496
1559
|
- **Accept**: application/json
|
1497
1560
|
|
1498
1561
|
|
1499
1562
|
|
1500
1563
|
# **webhooks_id_webhook_add_to_data_get**
|
1501
|
-
> webhooks_id_webhook_add_to_data_get(id_webhook)
|
1564
|
+
> InlineResponse20040 webhooks_id_webhook_add_to_data_get(id_webhook, opts)
|
1502
1565
|
|
1503
1566
|
retrieve the list of the value to add in webhooks when sending the requested webhook
|
1504
1567
|
|
@@ -1520,10 +1583,14 @@ api_instance = BudgeaClient::AdministrationApi.new
|
|
1520
1583
|
|
1521
1584
|
id_webhook = 56 # Integer |
|
1522
1585
|
|
1586
|
+
opts = {
|
1587
|
+
expand: 'expand_example' # String |
|
1588
|
+
}
|
1523
1589
|
|
1524
1590
|
begin
|
1525
1591
|
#retrieve the list of the value to add in webhooks when sending the requested webhook
|
1526
|
-
api_instance.webhooks_id_webhook_add_to_data_get(id_webhook)
|
1592
|
+
result = api_instance.webhooks_id_webhook_add_to_data_get(id_webhook, opts)
|
1593
|
+
p result
|
1527
1594
|
rescue BudgeaClient::ApiError => e
|
1528
1595
|
puts "Exception when calling AdministrationApi->webhooks_id_webhook_add_to_data_get: #{e}"
|
1529
1596
|
end
|
@@ -1534,10 +1601,194 @@ end
|
|
1534
1601
|
Name | Type | Description | Notes
|
1535
1602
|
------------- | ------------- | ------------- | -------------
|
1536
1603
|
**id_webhook** | **Integer**| |
|
1604
|
+
**expand** | **String**| | [optional]
|
1537
1605
|
|
1538
1606
|
### Return type
|
1539
1607
|
|
1540
|
-
|
1608
|
+
[**InlineResponse20040**](InlineResponse20040.md)
|
1609
|
+
|
1610
|
+
### Authorization
|
1611
|
+
|
1612
|
+
[api_key](../README.md#api_key)
|
1613
|
+
|
1614
|
+
### HTTP request headers
|
1615
|
+
|
1616
|
+
- **Content-Type**: application/json, multipart/form-data
|
1617
|
+
- **Accept**: application/json
|
1618
|
+
|
1619
|
+
|
1620
|
+
|
1621
|
+
# **webhooks_id_webhook_add_to_data_key_delete**
|
1622
|
+
> Webhook webhooks_id_webhook_add_to_data_key_delete(id_webhook, key, opts)
|
1623
|
+
|
1624
|
+
delete the requested entry
|
1625
|
+
|
1626
|
+
|
1627
|
+
|
1628
|
+
### Example
|
1629
|
+
```ruby
|
1630
|
+
# load the gem
|
1631
|
+
require 'budgea_client'
|
1632
|
+
# setup authorization
|
1633
|
+
BudgeaClient.configure do |config|
|
1634
|
+
# Configure API key authorization: api_key
|
1635
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1636
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1637
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1638
|
+
end
|
1639
|
+
|
1640
|
+
api_instance = BudgeaClient::AdministrationApi.new
|
1641
|
+
|
1642
|
+
id_webhook = 56 # Integer |
|
1643
|
+
|
1644
|
+
key = 'key_example' # String |
|
1645
|
+
|
1646
|
+
opts = {
|
1647
|
+
expand: 'expand_example' # String |
|
1648
|
+
}
|
1649
|
+
|
1650
|
+
begin
|
1651
|
+
#delete the requested entry
|
1652
|
+
result = api_instance.webhooks_id_webhook_add_to_data_key_delete(id_webhook, key, opts)
|
1653
|
+
p result
|
1654
|
+
rescue BudgeaClient::ApiError => e
|
1655
|
+
puts "Exception when calling AdministrationApi->webhooks_id_webhook_add_to_data_key_delete: #{e}"
|
1656
|
+
end
|
1657
|
+
```
|
1658
|
+
|
1659
|
+
### Parameters
|
1660
|
+
|
1661
|
+
Name | Type | Description | Notes
|
1662
|
+
------------- | ------------- | ------------- | -------------
|
1663
|
+
**id_webhook** | **Integer**| |
|
1664
|
+
**key** | **String**| |
|
1665
|
+
**expand** | **String**| | [optional]
|
1666
|
+
|
1667
|
+
### Return type
|
1668
|
+
|
1669
|
+
[**Webhook**](Webhook.md)
|
1670
|
+
|
1671
|
+
### Authorization
|
1672
|
+
|
1673
|
+
[api_key](../README.md#api_key)
|
1674
|
+
|
1675
|
+
### HTTP request headers
|
1676
|
+
|
1677
|
+
- **Content-Type**: application/json, multipart/form-data
|
1678
|
+
- **Accept**: application/json
|
1679
|
+
|
1680
|
+
|
1681
|
+
|
1682
|
+
# **webhooks_id_webhook_add_to_data_key_get**
|
1683
|
+
> Webhook webhooks_id_webhook_add_to_data_key_get(id_webhook, key, opts)
|
1684
|
+
|
1685
|
+
retrieve the value to add in the requested webhook for the requested name
|
1686
|
+
|
1687
|
+
|
1688
|
+
|
1689
|
+
### Example
|
1690
|
+
```ruby
|
1691
|
+
# load the gem
|
1692
|
+
require 'budgea_client'
|
1693
|
+
# setup authorization
|
1694
|
+
BudgeaClient.configure do |config|
|
1695
|
+
# Configure API key authorization: api_key
|
1696
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1697
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1698
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1699
|
+
end
|
1700
|
+
|
1701
|
+
api_instance = BudgeaClient::AdministrationApi.new
|
1702
|
+
|
1703
|
+
id_webhook = 56 # Integer |
|
1704
|
+
|
1705
|
+
key = 'key_example' # String |
|
1706
|
+
|
1707
|
+
opts = {
|
1708
|
+
expand: 'expand_example' # String |
|
1709
|
+
}
|
1710
|
+
|
1711
|
+
begin
|
1712
|
+
#retrieve the value to add in the requested webhook for the requested name
|
1713
|
+
result = api_instance.webhooks_id_webhook_add_to_data_key_get(id_webhook, key, opts)
|
1714
|
+
p result
|
1715
|
+
rescue BudgeaClient::ApiError => e
|
1716
|
+
puts "Exception when calling AdministrationApi->webhooks_id_webhook_add_to_data_key_get: #{e}"
|
1717
|
+
end
|
1718
|
+
```
|
1719
|
+
|
1720
|
+
### Parameters
|
1721
|
+
|
1722
|
+
Name | Type | Description | Notes
|
1723
|
+
------------- | ------------- | ------------- | -------------
|
1724
|
+
**id_webhook** | **Integer**| |
|
1725
|
+
**key** | **String**| |
|
1726
|
+
**expand** | **String**| | [optional]
|
1727
|
+
|
1728
|
+
### Return type
|
1729
|
+
|
1730
|
+
[**Webhook**](Webhook.md)
|
1731
|
+
|
1732
|
+
### Authorization
|
1733
|
+
|
1734
|
+
[api_key](../README.md#api_key)
|
1735
|
+
|
1736
|
+
### HTTP request headers
|
1737
|
+
|
1738
|
+
- **Content-Type**: application/json, multipart/form-data
|
1739
|
+
- **Accept**: application/json
|
1740
|
+
|
1741
|
+
|
1742
|
+
|
1743
|
+
# **webhooks_id_webhook_add_to_data_key_post**
|
1744
|
+
> Webhook webhooks_id_webhook_add_to_data_key_post(id_webhook, key, opts)
|
1745
|
+
|
1746
|
+
upate the requested field to store in user config when calling the endpoint
|
1747
|
+
|
1748
|
+
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.<br><br>
|
1749
|
+
|
1750
|
+
### Example
|
1751
|
+
```ruby
|
1752
|
+
# load the gem
|
1753
|
+
require 'budgea_client'
|
1754
|
+
# setup authorization
|
1755
|
+
BudgeaClient.configure do |config|
|
1756
|
+
# Configure API key authorization: api_key
|
1757
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1758
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1759
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1760
|
+
end
|
1761
|
+
|
1762
|
+
api_instance = BudgeaClient::AdministrationApi.new
|
1763
|
+
|
1764
|
+
id_webhook = 56 # Integer |
|
1765
|
+
|
1766
|
+
key = 'key_example' # String |
|
1767
|
+
|
1768
|
+
opts = {
|
1769
|
+
expand: 'expand_example' # String |
|
1770
|
+
}
|
1771
|
+
|
1772
|
+
begin
|
1773
|
+
#upate the requested field to store in user config when calling the endpoint
|
1774
|
+
result = api_instance.webhooks_id_webhook_add_to_data_key_post(id_webhook, key, opts)
|
1775
|
+
p result
|
1776
|
+
rescue BudgeaClient::ApiError => e
|
1777
|
+
puts "Exception when calling AdministrationApi->webhooks_id_webhook_add_to_data_key_post: #{e}"
|
1778
|
+
end
|
1779
|
+
```
|
1780
|
+
|
1781
|
+
### Parameters
|
1782
|
+
|
1783
|
+
Name | Type | Description | Notes
|
1784
|
+
------------- | ------------- | ------------- | -------------
|
1785
|
+
**id_webhook** | **Integer**| |
|
1786
|
+
**key** | **String**| |
|
1787
|
+
**expand** | **String**| | [optional]
|
1788
|
+
|
1789
|
+
### Return type
|
1790
|
+
|
1791
|
+
[**Webhook**](Webhook.md)
|
1541
1792
|
|
1542
1793
|
### Authorization
|
1543
1794
|
|
@@ -1545,7 +1796,65 @@ nil (empty response body)
|
|
1545
1796
|
|
1546
1797
|
### HTTP request headers
|
1547
1798
|
|
1548
|
-
- **Content-Type**: application/
|
1799
|
+
- **Content-Type**: application/json, multipart/form-data
|
1800
|
+
- **Accept**: application/json
|
1801
|
+
|
1802
|
+
|
1803
|
+
|
1804
|
+
# **webhooks_id_webhook_add_to_data_post**
|
1805
|
+
> Webhook webhooks_id_webhook_add_to_data_post(id_webhook, opts)
|
1806
|
+
|
1807
|
+
Setup a field to store in user config when calling the endpoint
|
1808
|
+
|
1809
|
+
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.<br><br>
|
1810
|
+
|
1811
|
+
### Example
|
1812
|
+
```ruby
|
1813
|
+
# load the gem
|
1814
|
+
require 'budgea_client'
|
1815
|
+
# setup authorization
|
1816
|
+
BudgeaClient.configure do |config|
|
1817
|
+
# Configure API key authorization: api_key
|
1818
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1819
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1820
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1821
|
+
end
|
1822
|
+
|
1823
|
+
api_instance = BudgeaClient::AdministrationApi.new
|
1824
|
+
|
1825
|
+
id_webhook = 56 # Integer |
|
1826
|
+
|
1827
|
+
opts = {
|
1828
|
+
expand: 'expand_example' # String |
|
1829
|
+
}
|
1830
|
+
|
1831
|
+
begin
|
1832
|
+
#Setup a field to store in user config when calling the endpoint
|
1833
|
+
result = api_instance.webhooks_id_webhook_add_to_data_post(id_webhook, opts)
|
1834
|
+
p result
|
1835
|
+
rescue BudgeaClient::ApiError => e
|
1836
|
+
puts "Exception when calling AdministrationApi->webhooks_id_webhook_add_to_data_post: #{e}"
|
1837
|
+
end
|
1838
|
+
```
|
1839
|
+
|
1840
|
+
### Parameters
|
1841
|
+
|
1842
|
+
Name | Type | Description | Notes
|
1843
|
+
------------- | ------------- | ------------- | -------------
|
1844
|
+
**id_webhook** | **Integer**| |
|
1845
|
+
**expand** | **String**| | [optional]
|
1846
|
+
|
1847
|
+
### Return type
|
1848
|
+
|
1849
|
+
[**Webhook**](Webhook.md)
|
1850
|
+
|
1851
|
+
### Authorization
|
1852
|
+
|
1853
|
+
[api_key](../README.md#api_key)
|
1854
|
+
|
1855
|
+
### HTTP request headers
|
1856
|
+
|
1857
|
+
- **Content-Type**: application/json, multipart/form-data
|
1549
1858
|
- **Accept**: application/json
|
1550
1859
|
|
1551
1860
|
|
@@ -1603,13 +1912,13 @@ Name | Type | Description | Notes
|
|
1603
1912
|
|
1604
1913
|
### HTTP request headers
|
1605
1914
|
|
1606
|
-
- **Content-Type**: application/
|
1915
|
+
- **Content-Type**: application/json, multipart/form-data
|
1607
1916
|
- **Accept**: application/json
|
1608
1917
|
|
1609
1918
|
|
1610
1919
|
|
1611
1920
|
# **webhooks_id_webhook_logs_get**
|
1612
|
-
>
|
1921
|
+
> InlineResponse20042 webhooks_id_webhook_logs_get(id_webhook, opts)
|
1613
1922
|
|
1614
1923
|
Get webhooks logs.
|
1615
1924
|
|
@@ -1632,6 +1941,7 @@ api_instance = BudgeaClient::AdministrationApi.new
|
|
1632
1941
|
id_webhook = 56 # Integer |
|
1633
1942
|
|
1634
1943
|
opts = {
|
1944
|
+
id_user: 56, # Integer | limit number of results to this user
|
1635
1945
|
limit: 56, # Integer | limit number of results
|
1636
1946
|
offset: 56, # Integer | offset of first result
|
1637
1947
|
min_date: Date.parse('2013-10-20'), # Date | minimal (inclusive) date
|
@@ -1653,6 +1963,7 @@ end
|
|
1653
1963
|
Name | Type | Description | Notes
|
1654
1964
|
------------- | ------------- | ------------- | -------------
|
1655
1965
|
**id_webhook** | **Integer**| |
|
1966
|
+
**id_user** | **Integer**| limit number of results to this user | [optional]
|
1656
1967
|
**limit** | **Integer**| limit number of results | [optional]
|
1657
1968
|
**offset** | **Integer**| offset of first result | [optional]
|
1658
1969
|
**min_date** | **Date**| minimal (inclusive) date | [optional]
|
@@ -1661,7 +1972,7 @@ Name | Type | Description | Notes
|
|
1661
1972
|
|
1662
1973
|
### Return type
|
1663
1974
|
|
1664
|
-
[**
|
1975
|
+
[**InlineResponse20042**](InlineResponse20042.md)
|
1665
1976
|
|
1666
1977
|
### Authorization
|
1667
1978
|
|
@@ -1669,7 +1980,7 @@ Name | Type | Description | Notes
|
|
1669
1980
|
|
1670
1981
|
### HTTP request headers
|
1671
1982
|
|
1672
|
-
- **Content-Type**: application/
|
1983
|
+
- **Content-Type**: application/json, multipart/form-data
|
1673
1984
|
- **Accept**: application/json
|
1674
1985
|
|
1675
1986
|
|
@@ -1739,7 +2050,7 @@ Name | Type | Description | Notes
|
|
1739
2050
|
|
1740
2051
|
### HTTP request headers
|
1741
2052
|
|
1742
|
-
- **Content-Type**: application/
|
2053
|
+
- **Content-Type**: application/json, multipart/form-data
|
1743
2054
|
- **Accept**: application/json
|
1744
2055
|
|
1745
2056
|
|
@@ -1809,7 +2120,7 @@ Name | Type | Description | Notes
|
|
1809
2120
|
|
1810
2121
|
### HTTP request headers
|
1811
2122
|
|
1812
|
-
- **Content-Type**: application/
|
2123
|
+
- **Content-Type**: application/json, multipart/form-data
|
1813
2124
|
- **Accept**: application/json
|
1814
2125
|
|
1815
2126
|
|
@@ -1876,7 +2187,7 @@ Name | Type | Description | Notes
|
|
1876
2187
|
|
1877
2188
|
### HTTP request headers
|
1878
2189
|
|
1879
|
-
- **Content-Type**: application/
|
2190
|
+
- **Content-Type**: application/json, multipart/form-data
|
1880
2191
|
- **Accept**: application/json
|
1881
2192
|
|
1882
2193
|
|