budgea_client 5.3.8 → 5.4.0

data/config.json

@@ -7,5 +7,5 @@
   "gemHomepage": "https://github.com/cashbee-team/budgea_client",
   "moduleName": "BudgeaClient",
   "gemLicense": "Apache 2.0",
-  "gemVersion": "5.3.8"
+  "gemVersion": "5.4.0"
 }

data/docs/AuthenticationApi.md

@@ -10,6 +10,7 @@ Method | HTTP request | Description
 [**auth_token_access_post**](AuthenticationApi.md#auth_token_access_post) | **POST** /auth/token/access | Transform a temporary code to a access_token
 [**auth_token_code_get**](AuthenticationApi.md#auth_token_code_get) | **GET** /auth/token/code | Generate a user temporary token
 [**auth_token_delete**](AuthenticationApi.md#auth_token_delete) | **DELETE** /auth/token | Remove user access
+[**auth_token_post**](AuthenticationApi.md#auth_token_post) | **POST** /auth/token | Login to API with credentials
 [**certificate_type_get**](AuthenticationApi.md#certificate_type_get) | **GET** /certificate/{type} | Get the latest certificate of a type
 [**hash_delete**](AuthenticationApi.md#hash_delete) | **DELETE** /hash | Delete the user's connections
 [**users_id_user_delete**](AuthenticationApi.md#users_id_user_delete) | **DELETE** /users/{id_user} | Delete the user
@@ -356,6 +357,67 @@ nil (empty response body)
 
 
 
+# **auth_token_post**
+> InlineResponse2005 auth_token_post(opts)
+
+Login to API with credentials
+
+Request a new token by giving the client_id and client_secret
+
+### Example
+```ruby
+# load the gem
+require 'budgea_client'
+# setup authorization
+BudgeaClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = BudgeaClient::AuthenticationApi.new
+
+opts = { 
+  client_id: 'client_id_example', # String | 
+  client_secret: 'client_secret_example', # String | 
+  grant_type: 'grant_type_example', # String | grant type
+  scope: 'scope_example' # String | scope requested for the token
+}
+
+begin
+  #Login to API with credentials
+  result = api_instance.auth_token_post(opts)
+  p result
+rescue BudgeaClient::ApiError => e
+  puts "Exception when calling AuthenticationApi->auth_token_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | **String**|  | [optional] 
+ **client_secret** | **String**|  | [optional] 
+ **grant_type** | **String**| grant type | [optional] 
+ **scope** | **String**| scope requested for the token | [optional] 
+
+### Return type
+
+[**InlineResponse2005**](InlineResponse2005.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
 # **certificate_type_get**
 > Certificate certificate_type_get(type, opts)
 

data/docs/Connector.md

@@ -20,5 +20,6 @@ Name | Type | Description | Notes
 **restricted** | **BOOLEAN** | If true, new connections cannot be added with this connector | [default to false]
 **fields** | [**Array<Field>**](Field.md) |  | [optional] 
 **capabilities** | **Array<String>** |  | [optional] 
+**sources** | [**Array<ConnectorSource>**](ConnectorSource.md) |  | [optional] 
 
 

data/docs/ConnectorSource.md

@@ -11,5 +11,12 @@ Name | Type | Description | Notes
 **fallback** | **String** | Name of the source this fallback is for | [optional] 
 **disabled** | **DateTime** | This source is not used to synchronize the connection | [optional] 
 **priority** | **Integer** | The source priority order for the synchronization | [optional] 
+**capabilities** | **Array<String>** |  | [optional] 
+**available_auth_mechanisms** | **Array<String>** |  | [optional] 
+**urls** | **Array<String>** |  | [optional] 
+**available_transfer_mechanisms** | **Array<String>** |  | [optional] 
+**transfer_validate_mechanism** | **String** |  | [optional] 
+**transfer_execution_date_types** | **Array<String>** |  | [optional] 
+**transfer_execution_frequencies** | **Array<String>** |  | [optional] 
 
 

data/docs/Field.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **value** | **String** | Default value of the field | [optional] 
 **values** | [**Array<FieldValue>**](FieldValue.md) |  | [optional] 
 **required** | **BOOLEAN** | If true, field has to be set to synchronize the connection | [optional] [default to true]
-**auth_mechanisms** | **String** | Authentication mechanisms this field is used for | [optional] 
+**auth_mechanisms** | **Array<String>** | Authentication mechanisms this field is used for | [optional] 
+**connector_sources** | **Array<String>** |  | [optional] 
 
 

data/docs/InlineResponse2005.md

@@ -3,10 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**profile** | **Object** | the user profile data object | 
 **scope** | **String** | the token scope | 
 **token** | **String** | the requested token | 
-**expires_in** | **Integer** | duration in seconds of the token validity | [optional] 
-**user** | **Object** | the user data object | 
+**expire_in** | **Integer** | duration in seconds of the token validity | [optional] 
 
 

data/docs/PFMApi.md

@@ -380,11 +380,11 @@ nil (empty response body)
 
 
 # **auth_token_post**
-> InlineResponse2005 auth_token_post(username, password, application, opts)
+> InlineResponse2005 auth_token_post(opts)
 
 Login to API with credentials
 
-Request a new user token by giving an username and a password.<br><br><br><br>
+Request a new token by giving the client_id and client_secret
 
 ### Example
 ```ruby
@@ -400,19 +400,16 @@ end
 
 api_instance = BudgeaClient::PFMApi.new
 
-username = 'username_example' # String | username
-
-password = 'password_example' # String | password
-
-application = 'application_example' # String | application name
-
 opts = { 
+  client_id: 'client_id_example', # String | 
+  client_secret: 'client_secret_example', # String | 
+  grant_type: 'grant_type_example', # String | grant type
   scope: 'scope_example' # String | scope requested for the token
 }
 
 begin
   #Login to API with credentials
-  result = api_instance.auth_token_post(username, password, application, opts)
+  result = api_instance.auth_token_post(opts)
   p result
 rescue BudgeaClient::ApiError => e
   puts "Exception when calling PFMApi->auth_token_post: #{e}"
@@ -423,9 +420,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **username** | **String**| username | 
- **password** | **String**| password | 
- **application** | **String**| application name | 
+ **client_id** | **String**|  | [optional] 
+ **client_secret** | **String**|  | [optional] 
+ **grant_type** | **String**| grant type | [optional] 
  **scope** | **String**| scope requested for the token | [optional] 
 
 ### Return type

data/docs/Payment.md

@@ -0,0 +1,15 @@
+# BudgeaClient::Payment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID of the created payment request. | [optional] 
+**state** | **String** |  | [optional] 
+**error_code** | **String** |  | [optional] 
+**error_description** | **String** | Error message in case of an error. | [optional] 
+**id_connector** | **Integer** | ID of the bank connector to use to initiate the payment. | [optional] 
+**validate_uri** | **String** | The URL that must be presented to the PSU to validate the payment request. The URL is only available after the transfer has been validated. | [optional] 
+**client_redirect_uri** | **String** | The validate_uri callback URL that was provided when configuring the transfer request. | [optional] 
+**instructions** | [**Array<PaymentInstruction>**](PaymentInstruction.md) | The list of payment instructions. | [optional] 
+
+

data/docs/PaymentBeneficiary.md

@@ -0,0 +1,13 @@
+# BudgeaClient::PaymentBeneficiary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scheme_name** | **String** | The beneficiary number type: iban for IBAN, bban for BBAN. | [optional] 
+**identification** | **String** | The beneficiary account number, of type matching the scheme_name. | [optional] 
+**label** | **String** | Display name of the beneficiary. | [optional] 
+**merchant_scheme_name** | **String** | For merchant beneficiaries, the type of identifier: siret, siren, rcs, rna. | [optional] 
+**merchant_identification** | **String** | For merchant beneficiaries, the identifier, of type matching the merchant_scheme_name. | [optional] 
+**bic** | **String** | The BIC of the beneficiary if it could be determined from the IBAN, null otherwise. | [optional] 
+
+

data/docs/PaymentBeneficiaryRequest.md

@@ -0,0 +1,12 @@
+# BudgeaClient::PaymentBeneficiaryRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scheme_name** | **String** | The beneficiary number type: iban for IBAN, bban for BBAN (please note that BBAN is not supported by any connector yet). | 
+**identification** | **String** | The beneficiary account number, of type matching the scheme_name. | 
+**label** | **String** | Display name of the beneficiary. | 
+**merchant_scheme_name** | **String** | For merchant beneficiaries, the type of identifier: siret, siren, rcs, rna. | [optional] 
+**merchant_identification** | **String** | For merchant beneficiaries, the identifier, of type matching the merchant_scheme_name. | [optional] 
+
+

data/docs/PaymentData.md

@@ -0,0 +1,13 @@
+# BudgeaClient::PaymentData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id_connector** | **Integer** | ID of the bank connector to use to initiate the payment. The bank connector must be eligible to payments creation. The id_connector can be submitted later on if validated is false when you initiate the payment request. | [optional] 
+**client_redirect_uri** | **String** | The redirect URL to use when building the validation URL. The provided URL must not contain any query parameter, rely on the client_state parameter for state management. | 
+**client_state** | **String** | Optional value that will be added as a state query parameter to the redirect URL after validation. | [optional] 
+**beneficiary** | [**PaymentBeneficiaryRequest**](PaymentBeneficiaryRequest.md) |  | [optional] 
+**instructions** | [**Array<PaymentInstructionRequest>**](PaymentInstructionRequest.md) | The payment information. | 
+**validated** | **BOOLEAN** | Provide true to acknowledge payment validation at once. Otherwise, validation is deferred. | [optional] 
+
+

data/docs/PaymentErrorCode.md

@@ -0,0 +1,7 @@
+# BudgeaClient::PaymentErrorCode
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/PaymentInstruction.md

@@ -0,0 +1,12 @@
+# BudgeaClient::PaymentInstruction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference_id** | **String** | An identifier for the transaction. | [optional] 
+**currency** | **String** | The currency of the payment amount. | [optional] 
+**label** | **String** | Label of the payment. | [optional] 
+**execution_date_type** | **String** | The execution date type of the payment: first_open_day for a standard banking transfer, deferred for a scheduled transfer, instant for instant payment. Other values might be supported later. | [optional] 
+**beneficiary** | [**PaymentBeneficiary**](PaymentBeneficiary.md) |  | [optional] 
+
+

data/docs/PaymentInstructionRequest.md

@@ -0,0 +1,13 @@
+# BudgeaClient::PaymentInstructionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference_id** | **String** | An identifier for the transaction, set by the emitter client. If not provided, a random UUID value will be generated. | [optional] 
+**amount** | **Integer** | The amount of the payment. | 
+**currency** | **String** | The currency code of the payment amount, a per ISO 4217. | 
+**label** | **String** | Label of the payment. | 
+**execution_date_type** | **String** | The execution date type of the payment: first_open_day for a standard banking transfer, deferred for a scheduled transfer, instant for instant payment. Other values might be supported later. | 
+**beneficiary** | [**PaymentBeneficiaryRequest**](PaymentBeneficiaryRequest.md) |  | [optional] 
+
+

data/docs/PaymentRequest.md

@@ -0,0 +1,13 @@
+# BudgeaClient::PaymentRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id_connector** | **Integer** | ID of the bank connector to use to initiate the payment. The bank connector must be eligible to payments creation. The id_connector can be submitted later on if validated is false when you initiate the payment request. | [optional] 
+**client_redirect_uri** | **String** | The redirect URL to use when building the validation URL. The provided URL must not contain any query parameter, rely on the client_state parameter for state management. | 
+**client_state** | **String** | Optional value that will be added as a state query parameter to the redirect URL after validation. | [optional] 
+**beneficiary** | [**PaymentBeneficiaryRequest**](PaymentBeneficiaryRequest.md) |  | [optional] 
+**instructions** | [**Array<PaymentInstructionRequest>**](PaymentInstructionRequest.md) | The payment information. | 
+**validated** | **BOOLEAN** | Provide true to acknowledge payment validation at once. Otherwise, validation is deferred. | [optional] 
+
+

data/docs/PaymentState.md

@@ -0,0 +1,7 @@
+# BudgeaClient::PaymentState
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/PaymentsApi.md

@@ -0,0 +1,61 @@
+# BudgeaClient::PaymentsApi
+
+All URIs are relative to *https://demo.biapi.pro/2.0/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**payments_post**](PaymentsApi.md#payments_post) | **POST** /payments | Create and validate a payment request
+
+
+# **payments_post**
+> Payment payments_post(payment_data)
+
+Create and validate a payment request
+
+### Example
+```ruby
+# load the gem
+require 'budgea_client'
+# setup authorization
+BudgeaClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = BudgeaClient::PaymentsApi.new
+
+payment_data = BudgeaClient::PaymentRequest.new # PaymentRequest | 
+
+
+begin
+  #Create and validate a payment request
+  result = api_instance.payments_post(payment_data)
+  p result
+rescue BudgeaClient::ApiError => e
+  puts "Exception when calling PaymentsApi->payments_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payment_data** | [**PaymentRequest**](PaymentRequest.md)|  | 
+
+### Return type
+
+[**Payment**](Payment.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/lib/budgea_client.rb

@@ -92,6 +92,14 @@ require 'budgea_client/models/keyword'
 require 'budgea_client/models/locked_user'
 require 'budgea_client/models/oidc_whitelist'
 require 'budgea_client/models/order'
+require 'budgea_client/models/payment'
+require 'budgea_client/models/payment_beneficiary'
+require 'budgea_client/models/payment_beneficiary_request'
+require 'budgea_client/models/payment_error_code'
+require 'budgea_client/models/payment_instruction'
+require 'budgea_client/models/payment_instruction_request'
+require 'budgea_client/models/payment_request'
+require 'budgea_client/models/payment_state'
 require 'budgea_client/models/pocket'
 require 'budgea_client/models/profile'
 require 'budgea_client/models/project'
@@ -124,6 +132,7 @@ require 'budgea_client/api/documents_api'
 require 'budgea_client/api/ocr_api'
 require 'budgea_client/api/oidc_api'
 require 'budgea_client/api/pfm_api'
+require 'budgea_client/api/payments_api'
 require 'budgea_client/api/providers_api'
 require 'budgea_client/api/recipients_api'
 require 'budgea_client/api/terms_api'

data/lib/budgea_client/api/authentication_api.rb

@@ -360,6 +360,66 @@ module BudgeaClient
       end
       return data, status_code, headers
     end
+    # Login to API with credentials
+    # Request a new token by giving the client_id and client_secret
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :client_id 
+    # @option opts [String] :client_secret 
+    # @option opts [String] :grant_type grant type
+    # @option opts [String] :scope scope requested for the token
+    # @return [InlineResponse2005]
+    def auth_token_post(opts = {})
+      data, _status_code, _headers = auth_token_post_with_http_info(opts)
+      data
+    end
+
+    # Login to API with credentials
+    # Request a new token by giving the client_id and client_secret
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :client_id 
+    # @option opts [String] :client_secret 
+    # @option opts [String] :grant_type grant type
+    # @option opts [String] :scope scope requested for the token
+    # @return [Array<(InlineResponse2005, Fixnum, Hash)>] InlineResponse2005 data, response status code and response headers
+    def auth_token_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthenticationApi.auth_token_post ...'
+      end
+      # resource path
+      local_var_path = '/auth/token'
+
+      # 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 = {}
+      form_params['client_id'] = opts[:'client_id'] if !opts[:'client_id'].nil?
+      form_params['client_secret'] = opts[:'client_secret'] if !opts[:'client_secret'].nil?
+      form_params['grant_type'] = opts[:'grant_type'] if !opts[:'grant_type'].nil?
+      form_params['scope'] = opts[:'scope'] if !opts[:'scope'].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 => 'InlineResponse2005')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthenticationApi#auth_token_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get the latest certificate of a type
     # 
     # @param type