budgea_client 5.3.8 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14e4d4d0529c3621c27fb540cd7a33a8ceb967ce9aa6b278daa97b823c245bf6
-  data.tar.gz: c8d1f711e4a9d1efb482c585feedbe2842898c4ecbdc88d765b14f6989b3f822
+  metadata.gz: 874a87d4a79089c432c3689939fbb7ff18881c07254d4e10401253e81c128c44
+  data.tar.gz: 378533147fef2b30299b37fd8ce533ce766f0ce3972ec9903edd1be040f419f5
 SHA512:
-  metadata.gz: 4db13ef9ec5e38b4d65f14a04cfc880c3cf66ba3fdd69a931ccd8eb8fe1005202b46a378b9abcacf49e8b33a48b34cff19703149a90964a04cbd042c22c38ca3
-  data.tar.gz: 6b1cb5370f222fb2c3e8c0103be00368c96022e99573bf62f89466e9de6166b9c9c8336d525fc8eb82d6fa4c8ddc07caedf03ec1dc37e53e864427af2684866a
+  metadata.gz: ff20e03e3d7471054caafd2b7d107a7821ecccef14a30e357186646f4175fcd9469b795745323e8790c0d6306437a906ad53caa9d70134585f77ad7be78be242
+  data.tar.gz: fdaef52c788e666a1b1e3f3a4415f49d52ce9d62e54cce4a3660324f30d74f08dc221fe48343d3c81d1edc403686a9a4b81a4e6dcf4ef483f468d98d28403b25

data/Gemfile.lock

@@ -1,30 +1,31 @@
 PATH
   remote: .
   specs:
-    budgea_client (5.3.4)
+    budgea_client (5.4.0)
+      addressable (~> 2.3, >= 2.3.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ZenTest (4.11.1)
+    ZenTest (4.12.0)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
-    autotest-fsevent (0.2.14)
+    autotest-fsevent (0.2.18)
       sys-uname
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.9.25)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.3)
     hashdiff (0.3.7)
-    json (2.3.1)
+    json (2.5.1)
     public_suffix (3.0.3)
     rake (12.3.3)
     rspec (3.8.0)
@@ -41,8 +42,8 @@ GEM
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
     safe_yaml (1.0.4)
-    sys-uname (1.0.3)
-      ffi (>= 1.0.0)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     vcr (3.0.3)
@@ -66,4 +67,4 @@ DEPENDENCIES
   webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   1.16.6
+   1.17.3

data/README.md

@@ -7,7 +7,7 @@ No description provided (generated by Swagger Codegen https://github.com/swagger
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0
-- Package version: 5.3.8
+- Package version: 5.4.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build budgea_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./budgea_client-5.3.8.gem
+gem install ./budgea_client-5.4.0.gem
 ```
-(for development, run `gem install --dev ./budgea_client-5.3.8.gem` to install the development dependencies)
+(for development, run `gem install --dev ./budgea_client-5.4.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'budgea_client', '~> 5.3.8'
+    gem 'budgea_client', '~> 5.4.0'
 
 ### Install from Git
 
@@ -126,6 +126,7 @@ Class | Method | HTTP request | Description
 *BudgeaClient::AuthenticationApi* | [**auth_token_access_post**](docs/AuthenticationApi.md#auth_token_access_post) | **POST** /auth/token/access | Transform a temporary code to a access_token
 *BudgeaClient::AuthenticationApi* | [**auth_token_code_get**](docs/AuthenticationApi.md#auth_token_code_get) | **GET** /auth/token/code | Generate a user temporary token
 *BudgeaClient::AuthenticationApi* | [**auth_token_delete**](docs/AuthenticationApi.md#auth_token_delete) | **DELETE** /auth/token | Remove user access
+*BudgeaClient::AuthenticationApi* | [**auth_token_post**](docs/AuthenticationApi.md#auth_token_post) | **POST** /auth/token | Login to API with credentials
 *BudgeaClient::AuthenticationApi* | [**certificate_type_get**](docs/AuthenticationApi.md#certificate_type_get) | **GET** /certificate/{type} | Get the latest certificate of a type
 *BudgeaClient::AuthenticationApi* | [**hash_delete**](docs/AuthenticationApi.md#hash_delete) | **DELETE** /hash | Delete the user's connections
 *BudgeaClient::AuthenticationApi* | [**users_id_user_delete**](docs/AuthenticationApi.md#users_id_user_delete) | **DELETE** /users/{id_user} | Delete the user
@@ -421,6 +422,7 @@ Class | Method | HTTP request | Description
 *BudgeaClient::PFMApi* | [**users_id_user_profiles_me_put**](docs/PFMApi.md#users_id_user_profiles_me_put) | **PUT** /users/{id_user}/profiles/me | Change settings of the profile.
 *BudgeaClient::PFMApi* | [**users_id_user_resume_get**](docs/PFMApi.md#users_id_user_resume_get) | **GET** /users/{id_user}/resume | Get synthesis configuration of a specific user
 *BudgeaClient::PFMApi* | [**users_id_user_resume_post**](docs/PFMApi.md#users_id_user_resume_post) | **POST** /users/{id_user}/resume | Update synthesis configuration
+*BudgeaClient::PaymentsApi* | [**payments_post**](docs/PaymentsApi.md#payments_post) | **POST** /payments | Create and validate a payment request
 *BudgeaClient::ProvidersApi* | [**banks_get**](docs/ProvidersApi.md#banks_get) | **GET** /banks | Get list of connectors
 *BudgeaClient::ProvidersApi* | [**banks_id_connector_logos_get**](docs/ProvidersApi.md#banks_id_connector_logos_get) | **GET** /banks/{id_connector}/logos | Get all links to the files associated with this connector.
 *BudgeaClient::ProvidersApi* | [**banks_id_connector_logos_main_get**](docs/ProvidersApi.md#banks_id_connector_logos_main_get) | **GET** /banks/{id_connector}/logos/main | Get all links to the files associated with this connector.
@@ -710,6 +712,14 @@ Class | Method | HTTP request | Description
  - [BudgeaClient::LockedUser](docs/LockedUser.md)
  - [BudgeaClient::OidcWhitelist](docs/OidcWhitelist.md)
  - [BudgeaClient::Order](docs/Order.md)
+ - [BudgeaClient::Payment](docs/Payment.md)
+ - [BudgeaClient::PaymentBeneficiary](docs/PaymentBeneficiary.md)
+ - [BudgeaClient::PaymentBeneficiaryRequest](docs/PaymentBeneficiaryRequest.md)
+ - [BudgeaClient::PaymentErrorCode](docs/PaymentErrorCode.md)
+ - [BudgeaClient::PaymentInstruction](docs/PaymentInstruction.md)
+ - [BudgeaClient::PaymentInstructionRequest](docs/PaymentInstructionRequest.md)
+ - [BudgeaClient::PaymentRequest](docs/PaymentRequest.md)
+ - [BudgeaClient::PaymentState](docs/PaymentState.md)
  - [BudgeaClient::Pocket](docs/Pocket.md)
  - [BudgeaClient::Profile](docs/Profile.md)
  - [BudgeaClient::Project](docs/Project.md)

data/budgea_openapi.json

@@ -493,16 +493,10 @@
             "schema": {
               "required": [
                 "token",
-                "scope",
-                "user",
-                "profile"
+                "scope"
               ],
               "type": "object",
               "properties": {
-                "profile": {
-                  "type": "object",
-                  "description": "the user profile data object"
-                },
                 "scope": {
                   "type": "string",
                   "description": "the token scope"
@@ -511,53 +505,42 @@
                   "type": "string",
                   "description": "the requested token"
                 },
-                "expires_in": {
+                "expire_in": {
                   "type": "integer",
                   "description": "duration in seconds of the token validity"
-                },
-                "user": {
-                  "type": "object",
-                  "description": "the user data object"
                 }
               }
             },
             "description": "",
             "examples": {
-              "profile": {},
               "scope": "",
-              "token": "A37mwXNCblbWX0LrvpRq60sZ6NBft/t5tsHhADie56/TJscwSi8NSjVmUIf6iLqpDwPe6lyFXM3z7E/zKf9eRHUWzx4QryEgmCtwZ0XgQb9SE+HwaenwqwTuv1gHZD+n",
-              "user": {}
+              "token": "A37mwXNCblbWX0LrvpRq60sZ6NBft/t5tsHhADie56/TJscwSi8NSjVmUIf6iLqpDwPe6lyFXM3z7E/zKf9eRHUWzx4QryEgmCtwZ0XgQb9SE+HwaenwqwTuv1gHZD+n"
             }
           }
         },
         "tags": [
+          "Authentication",
           "PFM"
         ],
-        "description": "Request a new user token by giving an username and a password.<br><br><br><br>",
+        "description": "Request a new token by giving the client_id and client_secret",
         "parameters": [
           {
-            "required": true,
             "in": "formData",
             "type": "string",
-            "name": "username",
-            "description": "username"
+            "name": "client_id"
           },
           {
-            "required": true,
             "in": "formData",
             "type": "string",
-            "name": "password",
-            "description": "password"
+            "name": "client_secret"
           },
           {
-            "required": true,
             "in": "formData",
             "type": "string",
-            "name": "application",
-            "description": "application name"
+            "name": "grant_type",
+            "description": "grant type"
           },
           {
-            "required": false,
             "in": "formData",
             "type": "string",
             "name": "scope",
@@ -3458,6 +3441,35 @@
         "summary": "Delete the supplied authorized redirect uri"
       }
     },
+    "/payments": {
+      "post": {
+        "responses": {
+          "200": {
+            "description": "Successful POST on Payment resource",
+            "schema": {
+              "$ref": "#/definitions/Payment"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "in": "body",
+            "name": "payment_data",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/PaymentRequest"
+            }
+          }
+        ],
+        "tags": [
+          "Payments"
+        ],
+        "summary": "Create and validate a payment request",
+        "consumes": [
+          "application/json"
+        ]
+      }
+    },
     "/providers": {
       "get": {
         "responses": {
@@ -23487,6 +23499,12 @@
           "items": {
             "type": "string"
           }
+        },
+        "sources": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ConnectorSource"
+          }
         }
       },
       "example": {
@@ -23577,6 +23595,45 @@
         "priority": {
           "type": "integer",
           "description": "The source priority order for the synchronization"
+        },
+        "capabilities": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "available_auth_mechanisms": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "urls": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "available_transfer_mechanisms": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "transfer_validate_mechanism": {
+          "type": "string"
+        },
+        "transfer_execution_date_types": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "transfer_execution_frequencies": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "example": {
@@ -23645,8 +23702,17 @@
           "description": "If true, field has to be set to synchronize the connection"
         },
         "auth_mechanisms": {
-          "type": "string",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
           "description": "Authentication mechanisms this field is used for"
+        },
+        "connector_sources": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "example": {
@@ -26584,6 +26650,242 @@
         "name": "",
         "attacheable": true
       }
+    },
+    "PaymentRequest": {
+      "type": "object",
+      "required": ["client_redirect_uri", "instructions"],
+      "properties": {
+        "id_connector": {
+          "type": "integer",
+          "description": "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."
+        },
+        "client_redirect_uri": {
+          "type": "string",
+          "description": "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": {
+          "type": "string",
+          "description": "Optional value that will be added as a state query parameter to the redirect URL after validation."
+        },
+        "beneficiary": {
+          "$ref": "#/definitions/PaymentBeneficiaryRequest"
+        },
+        "instructions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PaymentInstructionRequest"
+          },
+          "description": "The payment information."
+        },
+        "validated": {
+          "type": "boolean",
+          "description": "Provide true to acknowledge payment validation at once. Otherwise, validation is deferred."
+        }
+      },
+      "additionalProperties": {}
+    },
+    "PaymentBeneficiaryRequest": {
+      "type": "object",
+      "required": ["scheme_name", "identification", "label"],
+      "properties": {
+        "scheme_name": {
+          "type": "string",
+          "description": "The beneficiary number type: iban for IBAN, bban for BBAN (please note that BBAN is not supported by any connector yet)."
+        },
+        "identification": {
+          "type": "string",
+          "description": "The beneficiary account number, of type matching the scheme_name."
+        },
+        "label": {
+          "type": "string",
+          "description": "Display name of the beneficiary."
+        },
+        "merchant_scheme_name": {
+          "type": "string",
+          "description": "For merchant beneficiaries, the type of identifier: siret, siren, rcs, rna."
+        },
+        "merchant_identification": {
+          "type": "string",
+          "description": "For merchant beneficiaries, the identifier, of type matching the merchant_scheme_name."
+        }
+      }
+    },
+    "PaymentInstructionRequest": {
+      "type": "object",
+      "required": ["amount", "currency", "label", "execution_date_type"],
+      "properties": {
+        "reference_id": {
+          "type": "string",
+          "description": "An identifier for the transaction, set by the emitter client. If not provided, a random UUID value will be generated."
+        },
+        "amount": {
+          "type": "integer",
+          "description": "The amount of the payment."
+        },
+        "currency": {
+          "type": "string",
+          "description": "The currency code of the payment amount, a per ISO 4217."
+        },
+        "label": {
+          "type": "string",
+          "description": "Label of the payment."
+        },
+        "execution_date_type": {
+          "type": "string",
+          "description": "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."
+        },
+        "execution_date": {
+          "type": "date",
+          "description": "The execution date for the transfer, only for deferred transfers."
+        },
+        "beneficiary": {
+          "$ref": "#/definitions/PaymentBeneficiaryRequest"
+        }
+      }
+    },
+    "Payment": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "integer",
+          "description": "The ID of the created payment request."
+        },
+        "state": {
+          "type": "string"
+        },
+        "error_code": {
+          "type": "string"
+        },
+        "error_description": {
+          "type": "string",
+          "nullable": true,
+          "description": "Error message in case of an error."
+        },
+        "id_connector": {
+          "type": "integer",
+          "nullable": true,
+          "description": "ID of the bank connector to use to initiate the payment."
+        },
+        "register_date": {
+          "type": "datetime",
+          "description": "Creation date of the transfer request."
+        },
+        "validate_uri": {
+          "type": "string",
+          "nullable": true,
+          "description": "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."
+        },
+        "client_redirect_uri": {
+          "type": "string",
+          "nullable": true,
+          "description": "The validate_uri callback URL that was provided when configuring the transfer request."
+        },
+        "instructions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PaymentInstruction"
+          },
+          "description": "The list of payment instructions."
+        }
+      }
+    },
+    "PaymentBeneficiary": {
+      "type": "object",
+      "properties": {
+        "scheme_name": {
+          "type": "string",
+          "description": "The beneficiary number type: iban for IBAN, bban for BBAN."
+        },
+        "identification": {
+          "type": "string",
+          "description": "The beneficiary account number, of type matching the scheme_name."
+        },
+        "label": {
+          "type": "string",
+          "description": "Display name of the beneficiary."
+        },
+        "merchant_scheme_name": {
+          "type": "string",
+          "description": "For merchant beneficiaries, the type of identifier: siret, siren, rcs, rna."
+        },
+        "merchant_identification": {
+          "type": "string",
+          "description": "For merchant beneficiaries, the identifier, of type matching the merchant_scheme_name."
+        },
+        "bic": {
+          "type": "string",
+          "nullable": true,
+          "description": "The BIC of the beneficiary if it could be determined from the IBAN, null otherwise."
+        }
+      }
+    },
+    "PaymentInstruction": {
+      "type": "object",
+      "properties": {
+        "reference_id": {
+          "type": "string",
+          "description": "An identifier for the transaction."
+        },
+        "amount": {
+          "type": "float",
+          "description": "The amount of the payment."
+        },
+        "currency": {
+          "type": "string",
+          "description": "The currency of the payment amount."
+        },
+        "label": {
+          "type": "string",
+          "description": "Label of the payment."
+        },
+        "execution_date_type": {
+          "type": "string",
+          "description": "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."
+        },
+        "execution_date": {
+          "type": "date",
+          "nullable": true,
+          "description": "The execution date of the payment (available when the payment is deferred or has been validated)"
+        },
+        "beneficiary": {
+          "$ref": "#/definitions/PaymentBeneficiary"
+        }
+      }
+    },
+    "PaymentState": {
+      "type": "string",
+      "description": "created\tThe payment request was registered, but not yet validated.\nvalidating\tThe payment request was validated and initialized with the bank. The validate_uri is available.\nerror\tAn error occurred while initializing the request with the bank. The error_code is available.\npending\tThe payment request has been validated on the bank website, but execution has not been confirmed yet.\nrejected\tThe payment request has been rejected by the bank or the user. The error_code is available.\ndone\tThe payment has been executed and confirmed by the bank.\nexpired\tThe payment has automatically expired because it did not have a definitive status (ie done or rejected) N days after its execution. N value is configurable with the payment.manual_expire_time_days configuration key.",
+      "enum": [
+        "created",
+        "validating",
+        "error",
+        "pending",
+        "rejected",
+        "done",
+        "expired"
+      ]
+    },
+    "PaymentErrorCode": {
+      "type": "string",
+      "description": "invalidEmitter\tIdentification of the emitter account is invalid, or transfer emission is not possible.\ninsufficientFunds\tThe balance of the emitter account is too low.\ninvalidAmount\tThe amount of the payment request is invalid or out of the authorized bounds.\ninvalidCurrency\tThe currency of the payment request is invalid or unsupported.\ninvalidDate\tThe execution date of the payment request is invalid or out of the supported bounds.\ninvalidBeneficiary\tThe beneficiary identification is invalid or unsupported.\ninvalidLabel\tThe label of the payment request does not match the constraints enforced by the bank.\nregulatoryReason\tThe request was aborted by the bank for regulatory reason (e.g. fraud detection).\nauthenticationFailed\tThe request was aborted because the end-user failed to identify with the bank.\nnoAnswerFromCustomer\tThe payment request expired without any interaction with the end-user.\nnoSpecifiedReason\tThe payment request was rejected by the bank without any reason.\nCancelledByUser\tThe payment was explicitly cancelled by the end-user.\nbankMessage\tThe bank sent an error message to the user.\ninvalidValue\tThe request contains invalid data.\nactionNeeded\tAn action is needed on the website by the user.\nbug\tA bug has occurred during the request validation.",
+      "enum": [
+        "invalidEmitter",
+        "insufficientFunds",
+        "invalidAmount",
+        "invalidCurrency",
+        "invalidDate",
+        "invalidBeneficiary",
+        "invalidLabel",
+        "regulatoryReason",
+        "authenticationFailed",
+        "noAnswerFromCustomer",
+        "noSpecifiedReason",
+        "CancelledByUser",
+        "bankMessage",
+        "invalidValue",
+        "actionNeeded",
+        "bug"
+      ]
     }
   },
   "basePath": "/2.0/",