docs/RecipientsApi.md in budgea_client-1.4.4 vs docs/RecipientsApi.md in budgea_client-2.0.0
- old
+ new
@@ -13,12 +13,12 @@
# **users_id_user_accounts_id_account_recipients_post**
> Recipient users_id_user_accounts_id_account_recipients_post(id_user, id_account, opts)
Add a recipient.
+if config key transfer.recipient.iban_white_list.enabled is set to 1, recipients whose IBAN are not from countries codes contained in transfer.recipient.iban_white_list.entries will be deleted<br><br>
-
### Example
```ruby
# load the gem
require 'budgea_client'
# setup authorization
@@ -29,18 +29,19 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::RecipientsApi.new
-id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
+id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
opts = {
- label: "label_example", # String | label of recipient
- iban: "iban_example", # String | iban of recipient
- expand: "expand_example" # String |
+ background: true, # BOOLEAN | if true, do synchronization in background
+ label: 'label_example', # String | label of recipient
+ iban: 'iban_example', # String | iban of recipient
+ expand: 'expand_example' # String |
}
begin
#Add a recipient.
result = api_instance.users_id_user_accounts_id_account_recipients_post(id_user, id_account, opts)
@@ -54,10 +55,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id_user** | **String**| Hint: you can use 'me' or 'all' |
**id_account** | **Integer**| |
+ **background** | **BOOLEAN**| if true, do synchronization in background | [optional]
**label** | **String**| label of recipient | [optional]
**iban** | **String**| iban of recipient | [optional]
**expand** | **String**| | [optional]
### Return type
@@ -78,12 +80,12 @@
# **users_id_user_connections_id_connection_accounts_id_account_recipients_post**
> Recipient users_id_user_connections_id_connection_accounts_id_account_recipients_post(id_user, id_connection, id_account, opts)
Add a recipient.
+if config key transfer.recipient.iban_white_list.enabled is set to 1, recipients whose IBAN are not from countries codes contained in transfer.recipient.iban_white_list.entries will be deleted<br><br>
-
### Example
```ruby
# load the gem
require 'budgea_client'
# setup authorization
@@ -94,20 +96,21 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::RecipientsApi.new
-id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
+id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
opts = {
- label: "label_example", # String | label of recipient
- iban: "iban_example", # String | iban of recipient
- expand: "expand_example" # String |
+ background: true, # BOOLEAN | if true, do synchronization in background
+ label: 'label_example', # String | label of recipient
+ iban: 'iban_example', # String | iban of recipient
+ expand: 'expand_example' # String |
}
begin
#Add a recipient.
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_recipients_post(id_user, id_connection, id_account, opts)
@@ -122,10 +125,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id_user** | **String**| Hint: you can use 'me' or 'all' |
**id_connection** | **Integer**| |
**id_account** | **Integer**| |
+ **background** | **BOOLEAN**| if true, do synchronization in background | [optional]
**label** | **String**| label of recipient | [optional]
**iban** | **String**| iban of recipient | [optional]
**expand** | **String**| | [optional]
### Return type
@@ -146,12 +150,12 @@
# **users_id_user_connections_id_connection_recipients_post**
> Recipient users_id_user_connections_id_connection_recipients_post(id_user, id_connection, opts)
Add a recipient.
+if config key transfer.recipient.iban_white_list.enabled is set to 1, recipients whose IBAN are not from countries codes contained in transfer.recipient.iban_white_list.entries will be deleted<br><br>
-
### Example
```ruby
# load the gem
require 'budgea_client'
# setup authorization
@@ -162,18 +166,19 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::RecipientsApi.new
-id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
+id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
opts = {
- label: "label_example", # String | label of recipient
- iban: "iban_example", # String | iban of recipient
- expand: "expand_example" # String |
+ background: true, # BOOLEAN | if true, do synchronization in background
+ label: 'label_example', # String | label of recipient
+ iban: 'iban_example', # String | iban of recipient
+ expand: 'expand_example' # String |
}
begin
#Add a recipient.
result = api_instance.users_id_user_connections_id_connection_recipients_post(id_user, id_connection, opts)
@@ -187,10 +192,11 @@
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id_user** | **String**| Hint: you can use 'me' or 'all' |
**id_connection** | **Integer**| |
+ **background** | **BOOLEAN**| if true, do synchronization in background | [optional]
**label** | **String**| label of recipient | [optional]
**iban** | **String**| iban of recipient | [optional]
**expand** | **String**| | [optional]
### Return type
@@ -211,12 +217,12 @@
# **users_id_user_recipients_post**
> Recipient users_id_user_recipients_post(id_user, opts)
Add a recipient.
+if config key transfer.recipient.iban_white_list.enabled is set to 1, recipients whose IBAN are not from countries codes contained in transfer.recipient.iban_white_list.entries will be deleted<br><br>
-
### Example
```ruby
# load the gem
require 'budgea_client'
# setup authorization
@@ -227,16 +233,17 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::RecipientsApi.new
-id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
+id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- label: "label_example", # String | label of recipient
- iban: "iban_example", # String | iban of recipient
- expand: "expand_example" # String |
+ background: true, # BOOLEAN | if true, do synchronization in background
+ label: 'label_example', # String | label of recipient
+ iban: 'iban_example', # String | iban of recipient
+ expand: 'expand_example' # String |
}
begin
#Add a recipient.
result = api_instance.users_id_user_recipients_post(id_user, opts)
@@ -249,9 +256,10 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id_user** | **String**| Hint: you can use 'me' or 'all' |
+ **background** | **BOOLEAN**| if true, do synchronization in background | [optional]
**label** | **String**| label of recipient | [optional]
**iban** | **String**| iban of recipient | [optional]
**expand** | **String**| | [optional]
### Return type