budgea_client 1.0.0

data/docs/Recipient.md

@@ -0,0 +1,22 @@
+# BudgeaClient::Recipient
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the recipient | 
+**id_account** | **Integer** | ID of the related account | 
+**id_target_account** | **Integer** | ID of the target account, in case of internal recipient | [optional] 
+**label** | **String** | Label of the recipient | 
+**bank_name** | **String** | Bank of the recipient | [optional] 
+**iban** | **String** | IBAN of the recipient | [optional] 
+**webid** | **String** | Webid of the recipient | [optional] 
+**category** | **String** | Category in which the recipient is | 
+**last_update** | **DateTime** | Last time we have fetched this recipient | 
+**time_scraped** | **DateTime** | First time we've seen this recipient | [optional] 
+**deleted** | **DateTime** | The recipient isn't found anymore on the bank | [optional] 
+**expire** | **DateTime** |  | [optional] 
+**enabled_at** | **DateTime** | It will be possible to do transfers to this recipient at this date | [optional] 
+**add_verified** | **BOOLEAN** | Was the recipient adding authorized | [optional] 
+**currency** | **Object** | Currency of the object | [optional] 
+
+

data/docs/RecipientsApi.md

@@ -0,0 +1,244 @@
+# BudgeaClient::RecipientsApi
+
+All URIs are relative to *https://demo.biapi.pro/2.0/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**users_id_user_accounts_id_account_recipients_post**](RecipientsApi.md#users_id_user_accounts_id_account_recipients_post) | **POST** /users/{id_user}/accounts/{id_account}/recipients | Add a recipient.
+[**users_id_user_connections_id_connection_accounts_id_account_recipients_post**](RecipientsApi.md#users_id_user_connections_id_connection_accounts_id_account_recipients_post) | **POST** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/recipients | Add a recipient.
+[**users_id_user_connections_id_connection_recipients_post**](RecipientsApi.md#users_id_user_connections_id_connection_recipients_post) | **POST** /users/{id_user}/connections/{id_connection}/recipients | Add a recipient.
+[**users_id_user_recipients_post**](RecipientsApi.md#users_id_user_recipients_post) | **POST** /users/{id_user}/recipients | Add a recipient.
+
+
+# **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.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'budgea_client'
+
+api_instance = BudgeaClient::RecipientsApi.new
+
+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 | 
+}
+
+begin
+  #Add a recipient.
+  result = api_instance.users_id_user_accounts_id_account_recipients_post(id_user, id_account, opts)
+  p result
+rescue BudgeaClient::ApiError => e
+  puts "Exception when calling RecipientsApi->users_id_user_accounts_id_account_recipients_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_user** | **String**| Hint: you can use 'me' or 'all' | 
+ **id_account** | **Integer**|  | 
+ **label** | **String**| label of recipient | [optional] 
+ **iban** | **String**| iban of recipient | [optional] 
+ **expand** | **String**|  | [optional] 
+
+### Return type
+
+[**Recipient**](Recipient.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **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.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'budgea_client'
+
+api_instance = BudgeaClient::RecipientsApi.new
+
+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 | 
+}
+
+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)
+  p result
+rescue BudgeaClient::ApiError => e
+  puts "Exception when calling RecipientsApi->users_id_user_connections_id_connection_accounts_id_account_recipients_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_user** | **String**| Hint: you can use 'me' or 'all' | 
+ **id_connection** | **Integer**|  | 
+ **id_account** | **Integer**|  | 
+ **label** | **String**| label of recipient | [optional] 
+ **iban** | **String**| iban of recipient | [optional] 
+ **expand** | **String**|  | [optional] 
+
+### Return type
+
+[**Recipient**](Recipient.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **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.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'budgea_client'
+
+api_instance = BudgeaClient::RecipientsApi.new
+
+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 | 
+}
+
+begin
+  #Add a recipient.
+  result = api_instance.users_id_user_connections_id_connection_recipients_post(id_user, id_connection, opts)
+  p result
+rescue BudgeaClient::ApiError => e
+  puts "Exception when calling RecipientsApi->users_id_user_connections_id_connection_recipients_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_user** | **String**| Hint: you can use 'me' or 'all' | 
+ **id_connection** | **Integer**|  | 
+ **label** | **String**| label of recipient | [optional] 
+ **iban** | **String**| iban of recipient | [optional] 
+ **expand** | **String**|  | [optional] 
+
+### Return type
+
+[**Recipient**](Recipient.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **users_id_user_recipients_post**
+> Recipient users_id_user_recipients_post(id_user, opts)
+
+Add a recipient.
+
+
+
+### Example
+```ruby
+# load the gem
+require 'budgea_client'
+
+api_instance = BudgeaClient::RecipientsApi.new
+
+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 | 
+}
+
+begin
+  #Add a recipient.
+  result = api_instance.users_id_user_recipients_post(id_user, opts)
+  p result
+rescue BudgeaClient::ApiError => e
+  puts "Exception when calling RecipientsApi->users_id_user_recipients_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_user** | **String**| Hint: you can use 'me' or 'all' | 
+ **label** | **String**| label of recipient | [optional] 
+ **iban** | **String**| iban of recipient | [optional] 
+ **expand** | **String**|  | [optional] 
+
+### Return type
+
+[**Recipient**](Recipient.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+

data/docs/Security.md

@@ -0,0 +1,12 @@
+# BudgeaClient::Security
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the security | 
+**code** | **String** | ISIN code of the security | [optional] 
+**name** | **String** | Name of the security | 
+**id_type** | **Integer** | ID of the security type | [optional] 
+**last_update** | **DateTime** | Last update of the security | [optional] 
+
+

data/docs/Subscription.md

@@ -0,0 +1,18 @@
+# BudgeaClient::Subscription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of subscription | 
+**id_connection** | **Integer** | ID of related connection | [optional] 
+**id_user** | **Integer** | ID of related user | 
+**number** | **String** | Subscription's number | 
+**label** | **String** | Label of the subscription | 
+**subscriber** | **String** | Name of the subscriber | [optional] 
+**validity** | **Date** | The subscription is valid until this date, if any | [optional] 
+**renewdate** | **Date** | Next renew date, if any | [optional] 
+**last_update** | **DateTime** | Last successful update of the subscription | [optional] 
+**deleted** | **DateTime** | This subscription is not found on the website anymore | [optional] 
+**disabled** | **DateTime** | This subscription has been deleted by user and will not be synchronized anymore | [optional] 
+
+

data/docs/TermsApi.md

@@ -0,0 +1,218 @@
+# BudgeaClient::TermsApi
+
+All URIs are relative to *https://demo.biapi.pro/2.0/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**terms_get**](TermsApi.md#terms_get) | **GET** /terms | Return the current terms and the content of the associated file
+[**terms_post**](TermsApi.md#terms_post) | **POST** /terms | Register a version of 'Terms of Service' in database
+[**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
+[**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
+
+
+# **terms_get**
+> InlineResponse20016 terms_get(opts)
+
+Return the current terms and the content of the associated file
+
+
+
+### Example
+```ruby
+# load the gem
+require 'budgea_client'
+
+api_instance = BudgeaClient::TermsApi.new
+
+opts = { 
+  expand: "expand_example" # String | 
+}
+
+begin
+  #Return the current terms and the content of the associated file
+  result = api_instance.terms_get(opts)
+  p result
+rescue BudgeaClient::ApiError => e
+  puts "Exception when calling TermsApi->terms_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **expand** | **String**|  | [optional] 
+
+### Return type
+
+[**InlineResponse20016**](InlineResponse20016.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **terms_post**
+> TermsOfService terms_post(opts)
+
+Register a version of 'Terms of Service' in database
+
+
+
+### Example
+```ruby
+# load the gem
+require 'budgea_client'
+
+api_instance = BudgeaClient::TermsApi.new
+
+opts = { 
+  version: "version_example", # String | Number of version
+  file_content: "file_content_example", # String | file containing the terms, optional
+  expand: "expand_example" # String | 
+}
+
+begin
+  #Register a version of 'Terms of Service' in database
+  result = api_instance.terms_post(opts)
+  p result
+rescue BudgeaClient::ApiError => e
+  puts "Exception when calling TermsApi->terms_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **version** | **String**| Number of version | [optional] 
+ **file_content** | **String**| file containing the terms, optional | [optional] 
+ **expand** | **String**|  | [optional] 
+
+### Return type
+
+[**TermsOfService**](TermsOfService.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **users_id_user_terms_get**
+> InlineResponse20016 users_id_user_terms_get(id_user, opts)
+
+Get active terms object for a specific user, only one terms can be active
+
+
+
+### Example
+```ruby
+# load the gem
+require 'budgea_client'
+
+api_instance = BudgeaClient::TermsApi.new
+
+id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
+
+opts = { 
+  expand: "expand_example" # String | 
+}
+
+begin
+  #Get active terms object for a specific user, only one terms can be active
+  result = api_instance.users_id_user_terms_get(id_user, opts)
+  p result
+rescue BudgeaClient::ApiError => e
+  puts "Exception when calling TermsApi->users_id_user_terms_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_user** | **String**| Hint: you can use 'me' or 'all' | 
+ **expand** | **String**|  | [optional] 
+
+### Return type
+
+[**InlineResponse20016**](InlineResponse20016.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **users_id_user_terms_post**
+> TermsOfService users_id_user_terms_post(id_user, opts)
+
+Register user's consent for a specific terms id
+
+
+
+### Example
+```ruby
+# load the gem
+require 'budgea_client'
+
+api_instance = BudgeaClient::TermsApi.new
+
+id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
+
+opts = { 
+  id_user2: 56, # Integer | user id (optionnal)
+  id_terms: 56, # Integer | terms id
+  expand: "expand_example" # String | 
+}
+
+begin
+  #Register user's consent for a specific terms id
+  result = api_instance.users_id_user_terms_post(id_user, opts)
+  p result
+rescue BudgeaClient::ApiError => e
+  puts "Exception when calling TermsApi->users_id_user_terms_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id_user** | **String**| Hint: you can use 'me' or 'all' | 
+ **id_user2** | **Integer**| user id (optionnal) | [optional] 
+ **id_terms** | **Integer**| terms id | [optional] 
+ **expand** | **String**|  | [optional] 
+
+### Return type
+
+[**TermsOfService**](TermsOfService.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+