budgea_client 5.0.4 → 5.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +19 -6
- data/budgea_openapi.json +1605 -1319
- data/config.json +1 -1
- data/docs/Account.md +1 -0
- data/docs/AdministrationApi.md +12 -12
- data/docs/BanksApi.md +263 -18
- data/docs/ConnectionsApi.md +251 -6
- data/docs/DocumentsApi.md +2 -2
- data/docs/InlineResponse20016.md +1 -1
- data/docs/InlineResponse20017.md +1 -1
- data/docs/InlineResponse20018.md +1 -1
- data/docs/InlineResponse20019.md +1 -1
- data/docs/InlineResponse20020.md +1 -1
- data/docs/InlineResponse20021.md +1 -1
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +1 -1
- data/docs/InlineResponse20027.md +1 -1
- data/docs/InlineResponse20028.md +1 -1
- data/docs/InlineResponse20029.md +1 -1
- data/docs/InlineResponse20030.md +1 -1
- data/docs/PFMApi.md +9 -9
- data/docs/ProvidersApi.md +253 -8
- data/docs/TermsApi.md +72 -7
- data/docs/TransfersApi.md +24 -24
- data/docs/UsersManagementApi.md +2 -2
- data/docs/WealthApi.md +53 -37
- data/lib/budgea_client/api/administration_api.rb +13 -13
- data/lib/budgea_client/api/banks_api.rb +273 -27
- data/lib/budgea_client/api/connections_api.rb +255 -9
- data/lib/budgea_client/api/documents_api.rb +3 -3
- data/lib/budgea_client/api/pfm_api.rb +11 -11
- data/lib/budgea_client/api/providers_api.rb +258 -12
- data/lib/budgea_client/api/terms_api.rb +75 -9
- data/lib/budgea_client/api/transfers_api.rb +36 -36
- data/lib/budgea_client/api/users_management_api.rb +3 -3
- data/lib/budgea_client/api/wealth_api.rb +77 -53
- data/lib/budgea_client/models/account.rb +12 -1
- data/lib/budgea_client/models/inline_response_200_16.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_17.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_18.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_19.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_20.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_21.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_22.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_23.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_24.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_25.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_26.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_27.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_28.rb +11 -11
- data/lib/budgea_client/models/inline_response_200_29.rb +18 -18
- data/lib/budgea_client/models/inline_response_200_30.rb +11 -11
- data/lib/budgea_client/version.rb +1 -1
- data/original_budgea_openapi.json +1559 -1474
- metadata +2 -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/pkg/budgea_client-4.0.3.gem +0 -0
data/docs/InlineResponse20029.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**transfers** | [**Array<Transfer>**](Transfer.md) | |
|
7
6
|
**total** | **Float** | total number of results | [optional]
|
7
|
+
**recipients** | [**Array<Recipient>**](Recipient.md) | |
|
8
8
|
|
9
9
|
|
data/docs/InlineResponse20030.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**transfers** | [**Array<Transfer>**](Transfer.md) | |
|
7
7
|
**total** | **Float** | total number of results | [optional]
|
8
8
|
|
9
9
|
|
data/docs/PFMApi.md
CHANGED
@@ -23,7 +23,7 @@ Method | HTTP request | Description
|
|
23
23
|
[**users_id_user_connections_id_connection_accounts_id_account_balances_get**](PFMApi.md#users_id_user_connections_id_connection_accounts_id_account_balances_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/balances | Get balances of accounts
|
24
24
|
[**users_id_user_connections_id_connection_accounts_id_account_operationsalert_get**](PFMApi.md#users_id_user_connections_id_connection_accounts_id_account_operationsalert_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert | Get a list of configurated alerts
|
25
25
|
[**users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete**](PFMApi.md#users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert/{id_operationsalert} | Delete an alert on transactions or investments
|
26
|
-
[**users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put**](PFMApi.md#users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put) | **PUT** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert/{id_operationsalert} | Edit an alert on transactions or
|
26
|
+
[**users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put**](PFMApi.md#users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put) | **PUT** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert/{id_operationsalert} | Edit an alert on transactions or investments
|
27
27
|
[**users_id_user_connections_id_connection_accounts_id_account_operationsalert_post**](PFMApi.md#users_id_user_connections_id_connection_accounts_id_account_operationsalert_post) | **POST** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert | Create an alert on transactions or investments of a given user
|
28
28
|
[**users_id_user_connections_id_connection_balances_get**](PFMApi.md#users_id_user_connections_id_connection_balances_get) | **GET** /users/{id_user}/connections/{id_connection}/balances | Get balances of accounts
|
29
29
|
[**users_id_user_devices_get**](PFMApi.md#users_id_user_devices_get) | **GET** /users/{id_user}/devices | Get devices
|
@@ -555,7 +555,7 @@ nil (empty response body)
|
|
555
555
|
|
556
556
|
|
557
557
|
# **users_id_user_accounts_id_account_operationsalert_get**
|
558
|
-
>
|
558
|
+
> InlineResponse20028 users_id_user_accounts_id_account_operationsalert_get(id_user, id_account, opts)
|
559
559
|
|
560
560
|
Get a list of configurated alerts
|
561
561
|
|
@@ -602,7 +602,7 @@ Name | Type | Description | Notes
|
|
602
602
|
|
603
603
|
### Return type
|
604
604
|
|
605
|
-
[**
|
605
|
+
[**InlineResponse20028**](InlineResponse20028.md)
|
606
606
|
|
607
607
|
### Authorization
|
608
608
|
|
@@ -1073,7 +1073,7 @@ nil (empty response body)
|
|
1073
1073
|
|
1074
1074
|
|
1075
1075
|
# **users_id_user_connections_id_connection_accounts_id_account_operationsalert_get**
|
1076
|
-
>
|
1076
|
+
> InlineResponse20028 users_id_user_connections_id_connection_accounts_id_account_operationsalert_get(id_user, id_connection, id_account, opts)
|
1077
1077
|
|
1078
1078
|
Get a list of configurated alerts
|
1079
1079
|
|
@@ -1123,7 +1123,7 @@ Name | Type | Description | Notes
|
|
1123
1123
|
|
1124
1124
|
### Return type
|
1125
1125
|
|
1126
|
-
[**
|
1126
|
+
[**InlineResponse20028**](InlineResponse20028.md)
|
1127
1127
|
|
1128
1128
|
### Authorization
|
1129
1129
|
|
@@ -1206,7 +1206,7 @@ Name | Type | Description | Notes
|
|
1206
1206
|
# **users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put**
|
1207
1207
|
> UserAlert users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put(id_user, id_connection, id_account, id_operationsalert, opts)
|
1208
1208
|
|
1209
|
-
Edit an alert on transactions or
|
1209
|
+
Edit an alert on transactions or investments
|
1210
1210
|
|
1211
1211
|
|
1212
1212
|
|
@@ -1242,7 +1242,7 @@ opts = {
|
|
1242
1242
|
}
|
1243
1243
|
|
1244
1244
|
begin
|
1245
|
-
#Edit an alert on transactions or
|
1245
|
+
#Edit an alert on transactions or investments
|
1246
1246
|
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put(id_user, id_connection, id_account, id_operationsalert, opts)
|
1247
1247
|
p result
|
1248
1248
|
rescue BudgeaClient::ApiError => e
|
@@ -1845,7 +1845,7 @@ Name | Type | Description | Notes
|
|
1845
1845
|
|
1846
1846
|
|
1847
1847
|
# **users_id_user_operationsalert_get**
|
1848
|
-
>
|
1848
|
+
> InlineResponse20028 users_id_user_operationsalert_get(id_user, opts)
|
1849
1849
|
|
1850
1850
|
Get a list of configurated alerts
|
1851
1851
|
|
@@ -1889,7 +1889,7 @@ Name | Type | Description | Notes
|
|
1889
1889
|
|
1890
1890
|
### Return type
|
1891
1891
|
|
1892
|
-
[**
|
1892
|
+
[**InlineResponse20028**](InlineResponse20028.md)
|
1893
1893
|
|
1894
1894
|
### Authorization
|
1895
1895
|
|
data/docs/ProvidersApi.md
CHANGED
@@ -11,6 +11,10 @@ Method | HTTP request | Description
|
|
11
11
|
[**banks_id_connector_sources_get**](ProvidersApi.md#banks_id_connector_sources_get) | **GET** /banks/{id_connector}/sources | Get list of connector sources
|
12
12
|
[**connections_get**](ProvidersApi.md#connections_get) | **GET** /connections | Get connections without a user
|
13
13
|
[**connections_id_connection_logs_get**](ProvidersApi.md#connections_id_connection_logs_get) | **GET** /connections/{id_connection}/logs | Get connection logs
|
14
|
+
[**connections_id_connection_sources_get**](ProvidersApi.md#connections_id_connection_sources_get) | **GET** /connections/{id_connection}/sources | Get connection sources
|
15
|
+
[**connections_id_connection_sources_id_source_delete**](ProvidersApi.md#connections_id_connection_sources_id_source_delete) | **DELETE** /connections/{id_connection}/sources/{id_source} | Disable a connection source
|
16
|
+
[**connections_id_connection_sources_id_source_post**](ProvidersApi.md#connections_id_connection_sources_id_source_post) | **POST** /connections/{id_connection}/sources/{id_source} | Enable connection source
|
17
|
+
[**connections_id_connection_sources_id_source_put**](ProvidersApi.md#connections_id_connection_sources_id_source_put) | **PUT** /connections/{id_connection}/sources/{id_source} | Enable connection source
|
14
18
|
[**connectors_get**](ProvidersApi.md#connectors_get) | **GET** /connectors | Get list of connectors
|
15
19
|
[**connectors_id_connector_logos_get**](ProvidersApi.md#connectors_id_connector_logos_get) | **GET** /connectors/{id_connector}/logos | Get all links to the files associated with this connector.
|
16
20
|
[**connectors_id_connector_logos_id_logo_delete**](ProvidersApi.md#connectors_id_connector_logos_id_logo_delete) | **DELETE** /connectors/{id_connector}/logos/{id_logo} | Delete a single Logo object.
|
@@ -550,8 +554,249 @@ Name | Type | Description | Notes
|
|
550
554
|
|
551
555
|
|
552
556
|
|
557
|
+
# **connections_id_connection_sources_get**
|
558
|
+
> InlineResponse20016 connections_id_connection_sources_get(id_connection, opts)
|
559
|
+
|
560
|
+
Get connection sources
|
561
|
+
|
562
|
+
|
563
|
+
|
564
|
+
### Example
|
565
|
+
```ruby
|
566
|
+
# load the gem
|
567
|
+
require 'budgea_client'
|
568
|
+
# setup authorization
|
569
|
+
BudgeaClient.configure do |config|
|
570
|
+
# Configure API key authorization: api_key
|
571
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
572
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
573
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
574
|
+
end
|
575
|
+
|
576
|
+
api_instance = BudgeaClient::ProvidersApi.new
|
577
|
+
|
578
|
+
id_connection = 56 # Integer |
|
579
|
+
|
580
|
+
opts = {
|
581
|
+
expand: 'expand_example' # String |
|
582
|
+
}
|
583
|
+
|
584
|
+
begin
|
585
|
+
#Get connection sources
|
586
|
+
result = api_instance.connections_id_connection_sources_get(id_connection, opts)
|
587
|
+
p result
|
588
|
+
rescue BudgeaClient::ApiError => e
|
589
|
+
puts "Exception when calling ProvidersApi->connections_id_connection_sources_get: #{e}"
|
590
|
+
end
|
591
|
+
```
|
592
|
+
|
593
|
+
### Parameters
|
594
|
+
|
595
|
+
Name | Type | Description | Notes
|
596
|
+
------------- | ------------- | ------------- | -------------
|
597
|
+
**id_connection** | **Integer**| |
|
598
|
+
**expand** | **String**| | [optional]
|
599
|
+
|
600
|
+
### Return type
|
601
|
+
|
602
|
+
[**InlineResponse20016**](InlineResponse20016.md)
|
603
|
+
|
604
|
+
### Authorization
|
605
|
+
|
606
|
+
[api_key](../README.md#api_key)
|
607
|
+
|
608
|
+
### HTTP request headers
|
609
|
+
|
610
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
611
|
+
- **Accept**: application/json
|
612
|
+
|
613
|
+
|
614
|
+
|
615
|
+
# **connections_id_connection_sources_id_source_delete**
|
616
|
+
> ConnectionSource connections_id_connection_sources_id_source_delete(id_connection, id_source, opts)
|
617
|
+
|
618
|
+
Disable a connection source
|
619
|
+
|
620
|
+
This will make it so the specified source will not be synchronized anymore.<br><br>
|
621
|
+
|
622
|
+
### Example
|
623
|
+
```ruby
|
624
|
+
# load the gem
|
625
|
+
require 'budgea_client'
|
626
|
+
# setup authorization
|
627
|
+
BudgeaClient.configure do |config|
|
628
|
+
# Configure API key authorization: api_key
|
629
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
630
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
631
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
632
|
+
end
|
633
|
+
|
634
|
+
api_instance = BudgeaClient::ProvidersApi.new
|
635
|
+
|
636
|
+
id_connection = 56 # Integer |
|
637
|
+
|
638
|
+
id_source = 56 # Integer |
|
639
|
+
|
640
|
+
opts = {
|
641
|
+
expand: 'expand_example' # String |
|
642
|
+
}
|
643
|
+
|
644
|
+
begin
|
645
|
+
#Disable a connection source
|
646
|
+
result = api_instance.connections_id_connection_sources_id_source_delete(id_connection, id_source, opts)
|
647
|
+
p result
|
648
|
+
rescue BudgeaClient::ApiError => e
|
649
|
+
puts "Exception when calling ProvidersApi->connections_id_connection_sources_id_source_delete: #{e}"
|
650
|
+
end
|
651
|
+
```
|
652
|
+
|
653
|
+
### Parameters
|
654
|
+
|
655
|
+
Name | Type | Description | Notes
|
656
|
+
------------- | ------------- | ------------- | -------------
|
657
|
+
**id_connection** | **Integer**| |
|
658
|
+
**id_source** | **Integer**| |
|
659
|
+
**expand** | **String**| | [optional]
|
660
|
+
|
661
|
+
### Return type
|
662
|
+
|
663
|
+
[**ConnectionSource**](ConnectionSource.md)
|
664
|
+
|
665
|
+
### Authorization
|
666
|
+
|
667
|
+
[api_key](../README.md#api_key)
|
668
|
+
|
669
|
+
### HTTP request headers
|
670
|
+
|
671
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
672
|
+
- **Accept**: application/json
|
673
|
+
|
674
|
+
|
675
|
+
|
676
|
+
# **connections_id_connection_sources_id_source_post**
|
677
|
+
> ConnectionSource connections_id_connection_sources_id_source_post(id_connection, id_source, opts)
|
678
|
+
|
679
|
+
Enable connection source
|
680
|
+
|
681
|
+
This will make it so the specified source will be able to be synchronized.<br><br>
|
682
|
+
|
683
|
+
### Example
|
684
|
+
```ruby
|
685
|
+
# load the gem
|
686
|
+
require 'budgea_client'
|
687
|
+
# setup authorization
|
688
|
+
BudgeaClient.configure do |config|
|
689
|
+
# Configure API key authorization: api_key
|
690
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
691
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
692
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
693
|
+
end
|
694
|
+
|
695
|
+
api_instance = BudgeaClient::ProvidersApi.new
|
696
|
+
|
697
|
+
id_connection = 56 # Integer |
|
698
|
+
|
699
|
+
id_source = 56 # Integer |
|
700
|
+
|
701
|
+
opts = {
|
702
|
+
expand: 'expand_example' # String |
|
703
|
+
}
|
704
|
+
|
705
|
+
begin
|
706
|
+
#Enable connection source
|
707
|
+
result = api_instance.connections_id_connection_sources_id_source_post(id_connection, id_source, opts)
|
708
|
+
p result
|
709
|
+
rescue BudgeaClient::ApiError => e
|
710
|
+
puts "Exception when calling ProvidersApi->connections_id_connection_sources_id_source_post: #{e}"
|
711
|
+
end
|
712
|
+
```
|
713
|
+
|
714
|
+
### Parameters
|
715
|
+
|
716
|
+
Name | Type | Description | Notes
|
717
|
+
------------- | ------------- | ------------- | -------------
|
718
|
+
**id_connection** | **Integer**| |
|
719
|
+
**id_source** | **Integer**| |
|
720
|
+
**expand** | **String**| | [optional]
|
721
|
+
|
722
|
+
### Return type
|
723
|
+
|
724
|
+
[**ConnectionSource**](ConnectionSource.md)
|
725
|
+
|
726
|
+
### Authorization
|
727
|
+
|
728
|
+
[api_key](../README.md#api_key)
|
729
|
+
|
730
|
+
### HTTP request headers
|
731
|
+
|
732
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
733
|
+
- **Accept**: application/json
|
734
|
+
|
735
|
+
|
736
|
+
|
737
|
+
# **connections_id_connection_sources_id_source_put**
|
738
|
+
> ConnectionSource connections_id_connection_sources_id_source_put(id_connection, id_source, opts)
|
739
|
+
|
740
|
+
Enable connection source
|
741
|
+
|
742
|
+
This will make it so the specified source will be able to be synchronized.<br><br>
|
743
|
+
|
744
|
+
### Example
|
745
|
+
```ruby
|
746
|
+
# load the gem
|
747
|
+
require 'budgea_client'
|
748
|
+
# setup authorization
|
749
|
+
BudgeaClient.configure do |config|
|
750
|
+
# Configure API key authorization: api_key
|
751
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
752
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
753
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
754
|
+
end
|
755
|
+
|
756
|
+
api_instance = BudgeaClient::ProvidersApi.new
|
757
|
+
|
758
|
+
id_connection = 56 # Integer |
|
759
|
+
|
760
|
+
id_source = 56 # Integer |
|
761
|
+
|
762
|
+
opts = {
|
763
|
+
expand: 'expand_example' # String |
|
764
|
+
}
|
765
|
+
|
766
|
+
begin
|
767
|
+
#Enable connection source
|
768
|
+
result = api_instance.connections_id_connection_sources_id_source_put(id_connection, id_source, opts)
|
769
|
+
p result
|
770
|
+
rescue BudgeaClient::ApiError => e
|
771
|
+
puts "Exception when calling ProvidersApi->connections_id_connection_sources_id_source_put: #{e}"
|
772
|
+
end
|
773
|
+
```
|
774
|
+
|
775
|
+
### Parameters
|
776
|
+
|
777
|
+
Name | Type | Description | Notes
|
778
|
+
------------- | ------------- | ------------- | -------------
|
779
|
+
**id_connection** | **Integer**| |
|
780
|
+
**id_source** | **Integer**| |
|
781
|
+
**expand** | **String**| | [optional]
|
782
|
+
|
783
|
+
### Return type
|
784
|
+
|
785
|
+
[**ConnectionSource**](ConnectionSource.md)
|
786
|
+
|
787
|
+
### Authorization
|
788
|
+
|
789
|
+
[api_key](../README.md#api_key)
|
790
|
+
|
791
|
+
### HTTP request headers
|
792
|
+
|
793
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
794
|
+
- **Accept**: application/json
|
795
|
+
|
796
|
+
|
797
|
+
|
553
798
|
# **connectors_get**
|
554
|
-
>
|
799
|
+
> InlineResponse20017 connectors_get(opts)
|
555
800
|
|
556
801
|
Get list of connectors
|
557
802
|
|
@@ -592,7 +837,7 @@ Name | Type | Description | Notes
|
|
592
837
|
|
593
838
|
### Return type
|
594
839
|
|
595
|
-
[**
|
840
|
+
[**InlineResponse20017**](InlineResponse20017.md)
|
596
841
|
|
597
842
|
### Authorization
|
598
843
|
|
@@ -1215,7 +1460,7 @@ Name | Type | Description | Notes
|
|
1215
1460
|
|
1216
1461
|
|
1217
1462
|
# **documenttypes_get**
|
1218
|
-
>
|
1463
|
+
> InlineResponse20018 documenttypes_get(opts)
|
1219
1464
|
|
1220
1465
|
Get document types
|
1221
1466
|
|
@@ -1256,7 +1501,7 @@ Name | Type | Description | Notes
|
|
1256
1501
|
|
1257
1502
|
### Return type
|
1258
1503
|
|
1259
|
-
[**
|
1504
|
+
[**InlineResponse20018**](InlineResponse20018.md)
|
1260
1505
|
|
1261
1506
|
### Authorization
|
1262
1507
|
|
@@ -1470,7 +1715,7 @@ nil (empty response body)
|
|
1470
1715
|
|
1471
1716
|
|
1472
1717
|
# **providers_get**
|
1473
|
-
>
|
1718
|
+
> InlineResponse20020 providers_get(opts)
|
1474
1719
|
|
1475
1720
|
Get list of connectors
|
1476
1721
|
|
@@ -1511,7 +1756,7 @@ Name | Type | Description | Notes
|
|
1511
1756
|
|
1512
1757
|
### Return type
|
1513
1758
|
|
1514
|
-
[**
|
1759
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
1515
1760
|
|
1516
1761
|
### Authorization
|
1517
1762
|
|
@@ -4584,7 +4829,7 @@ Name | Type | Description | Notes
|
|
4584
4829
|
|
4585
4830
|
|
4586
4831
|
# **users_id_user_connections_id_connection_sources_get**
|
4587
|
-
>
|
4832
|
+
> InlineResponse20016 users_id_user_connections_id_connection_sources_get(id_user, id_connection, opts)
|
4588
4833
|
|
4589
4834
|
Get connection sources
|
4590
4835
|
|
@@ -4631,7 +4876,7 @@ Name | Type | Description | Notes
|
|
4631
4876
|
|
4632
4877
|
### Return type
|
4633
4878
|
|
4634
|
-
[**
|
4879
|
+
[**InlineResponse20016**](InlineResponse20016.md)
|
4635
4880
|
|
4636
4881
|
### Authorization
|
4637
4882
|
|
data/docs/TermsApi.md
CHANGED
@@ -5,13 +5,14 @@ All URIs are relative to *https://demo.biapi.pro/2.0/*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**terms_get**](TermsApi.md#terms_get) | **GET** /terms | Return the current terms and the content of the associated file
|
8
|
+
[**terms_id_term_post**](TermsApi.md#terms_id_term_post) | **POST** /terms/{id_term} | Add terms content for a language. Only for the active terms, there is no use to update obsolete terms
|
8
9
|
[**terms_post**](TermsApi.md#terms_post) | **POST** /terms | Register a version of 'Terms of Service' in database
|
9
10
|
[**users_id_user_terms_get**](TermsApi.md#users_id_user_terms_get) | **GET** /users/{id_user}/terms | Get active terms object for a specific user, only one terms can be active
|
10
11
|
[**users_id_user_terms_post**](TermsApi.md#users_id_user_terms_post) | **POST** /users/{id_user}/terms | Register user's consent for a specific terms id
|
11
12
|
|
12
13
|
|
13
14
|
# **terms_get**
|
14
|
-
>
|
15
|
+
> InlineResponse20021 terms_get(opts)
|
15
16
|
|
16
17
|
Return the current terms and the content of the associated file
|
17
18
|
|
@@ -52,7 +53,7 @@ Name | Type | Description | Notes
|
|
52
53
|
|
53
54
|
### Return type
|
54
55
|
|
55
|
-
[**
|
56
|
+
[**InlineResponse20021**](InlineResponse20021.md)
|
56
57
|
|
57
58
|
### Authorization
|
58
59
|
|
@@ -65,6 +66,68 @@ Name | Type | Description | Notes
|
|
65
66
|
|
66
67
|
|
67
68
|
|
69
|
+
# **terms_id_term_post**
|
70
|
+
> TermsOfService terms_id_term_post(id_term, opts)
|
71
|
+
|
72
|
+
Add terms content for a language. Only for the active terms, there is no use to update obsolete terms
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
### Example
|
77
|
+
```ruby
|
78
|
+
# load the gem
|
79
|
+
require 'budgea_client'
|
80
|
+
# setup authorization
|
81
|
+
BudgeaClient.configure do |config|
|
82
|
+
# Configure API key authorization: api_key
|
83
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
84
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
85
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
86
|
+
end
|
87
|
+
|
88
|
+
api_instance = BudgeaClient::TermsApi.new
|
89
|
+
|
90
|
+
id_term = 56 # Integer |
|
91
|
+
|
92
|
+
opts = {
|
93
|
+
language: 'language_example', # String | two letter code of the language to inserted
|
94
|
+
file_content: File.new('/path/to/file.txt'), # File | file containing the terms
|
95
|
+
expand: 'expand_example' # String |
|
96
|
+
}
|
97
|
+
|
98
|
+
begin
|
99
|
+
#Add terms content for a language. Only for the active terms, there is no use to update obsolete terms
|
100
|
+
result = api_instance.terms_id_term_post(id_term, opts)
|
101
|
+
p result
|
102
|
+
rescue BudgeaClient::ApiError => e
|
103
|
+
puts "Exception when calling TermsApi->terms_id_term_post: #{e}"
|
104
|
+
end
|
105
|
+
```
|
106
|
+
|
107
|
+
### Parameters
|
108
|
+
|
109
|
+
Name | Type | Description | Notes
|
110
|
+
------------- | ------------- | ------------- | -------------
|
111
|
+
**id_term** | **Integer**| |
|
112
|
+
**language** | **String**| two letter code of the language to inserted | [optional]
|
113
|
+
**file_content** | **File**| file containing the terms | [optional]
|
114
|
+
**expand** | **String**| | [optional]
|
115
|
+
|
116
|
+
### Return type
|
117
|
+
|
118
|
+
[**TermsOfService**](TermsOfService.md)
|
119
|
+
|
120
|
+
### Authorization
|
121
|
+
|
122
|
+
[api_key](../README.md#api_key)
|
123
|
+
|
124
|
+
### HTTP request headers
|
125
|
+
|
126
|
+
- **Content-Type**: multipart/form-data
|
127
|
+
- **Accept**: application/json
|
128
|
+
|
129
|
+
|
130
|
+
|
68
131
|
# **terms_post**
|
69
132
|
> TermsOfService terms_post(opts)
|
70
133
|
|
@@ -88,7 +151,8 @@ api_instance = BudgeaClient::TermsApi.new
|
|
88
151
|
|
89
152
|
opts = {
|
90
153
|
version: 'version_example', # String | Number of version
|
91
|
-
file_content: '
|
154
|
+
file_content: File.new('/path/to/file.txt'), # File | file containing the terms, optional
|
155
|
+
language: 'language_example', # String | two letters code of the language of the inserted terms if provided. default: 'fr'
|
92
156
|
expand: 'expand_example' # String |
|
93
157
|
}
|
94
158
|
|
@@ -106,7 +170,8 @@ end
|
|
106
170
|
Name | Type | Description | Notes
|
107
171
|
------------- | ------------- | ------------- | -------------
|
108
172
|
**version** | **String**| Number of version | [optional]
|
109
|
-
**file_content** | **
|
173
|
+
**file_content** | **File**| file containing the terms, optional | [optional]
|
174
|
+
**language** | **String**| two letters code of the language of the inserted terms if provided. default: 'fr' | [optional]
|
110
175
|
**expand** | **String**| | [optional]
|
111
176
|
|
112
177
|
### Return type
|
@@ -119,13 +184,13 @@ Name | Type | Description | Notes
|
|
119
184
|
|
120
185
|
### HTTP request headers
|
121
186
|
|
122
|
-
- **Content-Type**:
|
187
|
+
- **Content-Type**: multipart/form-data
|
123
188
|
- **Accept**: application/json
|
124
189
|
|
125
190
|
|
126
191
|
|
127
192
|
# **users_id_user_terms_get**
|
128
|
-
>
|
193
|
+
> InlineResponse20021 users_id_user_terms_get(id_user, opts)
|
129
194
|
|
130
195
|
Get active terms object for a specific user, only one terms can be active
|
131
196
|
|
@@ -169,7 +234,7 @@ Name | Type | Description | Notes
|
|
169
234
|
|
170
235
|
### Return type
|
171
236
|
|
172
|
-
[**
|
237
|
+
[**InlineResponse20021**](InlineResponse20021.md)
|
173
238
|
|
174
239
|
### Authorization
|
175
240
|
|