budgea_client 3.0.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bb5ee4f27d9bcdc26c39ae63f1ae7a106bd9f4760fc58958f6d3ae09a41e2dd
-  data.tar.gz: db7d8812a3122aa10098629c1680589cf0f7fce9228a434ed97447950a47d92e
+  metadata.gz: 533acc2e6ed24ba9ab39a30d79f6fa4a6b2538ac1d86938d7c61ee27a91941fd
+  data.tar.gz: 051c1bb40cef4448b81a338d1dfb792975d7214c9ba52038c0965ff43868cb34
 SHA512:
-  metadata.gz: 76ae9f9c2beac965c76e724584030d18042d0b8082fa5a1ac344f6cc5cc403cb1e0ba8e6dbabaf3a8f25c8772da1033db0fbd83beaa67afb9e1095c23531fd5c
-  data.tar.gz: 7850e313544cbb25687036b7e57eb1175b811ce1df680c7a86cba528fcfa028c14b6d9b3e57810ce9712b2ef5a0e60f42d12ef2f2ccb68adfc471252024dedb1
+  metadata.gz: 802bf727b9bb9879370e3fd429832b54b7fc762d0316de41e295db340067bbf85e75e402e28e446ac28bb39cd86a74b1a2fb13db31d43c3371b07866c6b953da
+  data.tar.gz: 1d65a4ea02073a263d9575855d239d23b8cec66b3cb78667f5e9ebbce1a7fd8673df8f354bb9f497223fc26e0d375433f47caaaa6408ecad1a9a3eccf9123f77

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    budgea_client (3.0.1)
+    budgea_client (4.0.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/budgea_openapi.json

@@ -14647,10 +14647,6 @@
               ],
               "type": "object",
               "properties": {
-                "total": {
-                  "type": "number",
-                  "description": "total number of results"
-                },
                 "total": {
                   "type": "number",
                   "description": "total number of results"
@@ -22035,6 +22031,12 @@
           "items": {
             "$ref": "#/definitions/Field"
           }
+        },
+        "capabilities": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       },
       "example": {

data/docs/Connector.md

@@ -19,5 +19,6 @@ Name | Type | Description | Notes
 **siret** | **String** | SIRET code for Bill modules | [optional] 
 **uuid** | **String** | Unique connector identifier | 
 **fields** | [**Array<Field>**](Field.md) |  | [optional] 
+**capabilities** | **Array<String>** |  | [optional] 
 
 

data/lib/budgea_client/models/connector.rb

@@ -58,6 +58,8 @@ module BudgeaClient
 
     attr_accessor :fields
 
+    attr_accessor :capabilities
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -76,7 +78,8 @@ module BudgeaClient
         :'auth_mechanism' => :'auth_mechanism',
         :'siret' => :'siret',
         :'uuid' => :'uuid',
-        :'fields' => :'fields'
+        :'fields' => :'fields',
+        :'capabilities' => :'capabilities'
       }
     end
 
@@ -98,7 +101,8 @@ module BudgeaClient
         :'auth_mechanism' => :'String',
         :'siret' => :'String',
         :'uuid' => :'String',
-        :'fields' => :'Array<Field>'
+        :'fields' => :'Array<Field>',
+        :'capabilities' => :'Array<String>'
       }
     end
 
@@ -183,6 +187,12 @@ module BudgeaClient
           self.fields = value
         end
       end
+
+      if attributes.has_key?(:'capabilities')
+        if (value = attributes[:'capabilities']).is_a?(Array)
+          self.capabilities = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -248,7 +258,8 @@ module BudgeaClient
           auth_mechanism == o.auth_mechanism &&
           siret == o.siret &&
           uuid == o.uuid &&
-          fields == o.fields
+          fields == o.fields &&
+          capabilities == o.capabilities
     end
 
     # @see the `==` method
@@ -260,7 +271,7 @@ module BudgeaClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, id_weboob, hidden, charged, code, beta, color, slug, sync_frequency, months_to_fetch, account_types, auth_mechanism, siret, uuid, fields].hash
+      [id, name, id_weboob, hidden, charged, code, beta, color, slug, sync_frequency, months_to_fetch, account_types, auth_mechanism, siret, uuid, fields, capabilities].hash
     end
 
     # Builds the object from hash

data/lib/budgea_client/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.1
 =end
 
 module BudgeaClient
-  VERSION = '3.0.1'
+  VERSION = '4.0.0'
 end

data/spec/api/administration_api_spec.rb

@@ -1,4 +1,14 @@
-# frozen_string_literal: true
+=begin
+#Budgea API Documentation
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.1
+
+=end
 
 require 'spec_helper'
 require 'json'
@@ -27,9 +37,9 @@ describe 'AdministrationApi' do
   # 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :expand 
-  # @return [InlineResponse20011]
+  # @return [InlineResponse20012]
   describe 'clients_get test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -42,20 +52,20 @@ describe 'AdministrationApi' do
   # @option opts [String] :expand 
   # @return [Client]
   describe 'clients_id_client_delete test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for clients_id_client_get
   # Get information about a client
-  # If you use the manage_token, you will get also the client_secret.<br><br>
+  # If you use the manage_token or a configuration token, you will get also the client_secret<br><br>
   # @param id_client 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :expand 
   # @return [Client]
   describe 'clients_id_client_get test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -68,7 +78,7 @@ describe 'AdministrationApi' do
   # @option opts [String] :expand 
   # @return [File]
   describe 'clients_id_client_logo_delete test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -81,7 +91,7 @@ describe 'AdministrationApi' do
   # @option opts [String] :expand 
   # @return [File]
   describe 'clients_id_client_logo_post test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -91,6 +101,7 @@ describe 'AdministrationApi' do
   # 
   # @param id_client 
   # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :generate_keys set a rsa key pair for the client, which make it possible to generate a jwt user token using this client. No effect if the client already has a set of keys(default: False)
   # @option opts [String] :name name of client
   # @option opts [BOOLEAN] :secret reset the secret
   # @option opts [String] :redirect_uri redirect_uri
@@ -100,10 +111,12 @@ describe 'AdministrationApi' do
   # @option opts [String] :description_banks text to display as a description for banks
   # @option opts [String] :description_providers text to display as a description for providers
   # @option opts [BOOLEAN] :pro Wether the client should display the company manager page
+  # @option opts [String] :config custom config about the client
+  # @option opts [BOOLEAN] :update_config update the custom information about the client instead of replacing the existing one (default: True)
   # @option opts [String] :expand 
   # @return [Client]
   describe 'clients_id_client_put test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -112,10 +125,14 @@ describe 'AdministrationApi' do
   # Create a client
   # 
   # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :generate_keys if True, generate a rsa pair of keys so the client can be used to generate jwt user tokens (default: False)
+  # @option opts [String] :name name of client
+  # @option opts [String] :redirect_uri redirect_uri
+  # @option opts [String] :config custom config about the client
   # @option opts [String] :expand 
   # @return [Client]
   describe 'clients_post test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -127,19 +144,88 @@ describe 'AdministrationApi' do
   # @option opts [String] :search limit the results to keys matching the given value
   # @return [nil]
   describe 'config_get test' do
-    it "should work" do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for config_logs_get
+  # Get configuration change history of the API.
+  # <br><br>
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :search limit the results to keys matching the given value
+  # @option opts [String] :type type of change done on the configuration
+  # @option opts [Date] :min_date minimal date of the change
+  # @option opts [Date] :max_date maximum date of the change
+  # @option opts [String] :expand 
+  # @return [InlineResponse20013]
+  describe 'config_logs_get test' do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for config_post
   # Set a configuration value on the API.
-  # Request: { \"bank.connection.disable_new\": \"0\", \"search\": \"bank.connection.disable_new\" }<br><br>
+  # Request: { \"connection.disable_new\": \"0\", \"search\": \"connection.disable_new\" }<br><br>
   # @param [Hash] opts the optional parameters
   # @option opts [String] :search limit the results to keys matching the given value
   # @return [Object]
   describe 'config_post test' do
-    it "should work" do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for merchants_get
+  # List clients
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :expand 
+  # @return [InlineResponse20012]
+  describe 'merchants_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for merchants_id_client_logo_delete
+  # Delete the client logo
+  # 
+  # @param id_client 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :expand 
+  # @return [File]
+  describe 'merchants_id_client_logo_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for merchants_id_client_logo_post
+  # Update the client logo
+  # 
+  # @param id_client 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :expand 
+  # @return [File]
+  describe 'merchants_id_client_logo_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for merchants_post
+  # Create a merchant. Needs a user identified in bearer to be used
+  # 
+  # @param name name of merchant
+  # @param redirect_uri regexp to check if given redirect_uri are authorized
+  # @param iban payments initiated by this merchant will be done to this IBAN
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :expand 
+  # @return [Client]
+  describe 'merchants_post test' do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -151,7 +237,7 @@ describe 'AdministrationApi' do
   # @option opts [Integer] :period number on days on which stats on synchronization have to be done per worker (Default: 1)
   # @return [nil]
   describe 'monitoring_get test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -162,7 +248,7 @@ describe 'AdministrationApi' do
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'test_sync_post test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -173,7 +259,91 @@ describe 'AdministrationApi' do
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'test_webhooks_post test' do
-    it "should work" do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for webhooks_auth_delete
+  # Deletes all webhook authentication types
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :expand 
+  # @return [AuthProvider]
+  describe 'webhooks_auth_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for webhooks_auth_get
+  # Get webhooks authentication types
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :expand 
+  # @return [InlineResponse20039]
+  describe 'webhooks_auth_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for webhooks_auth_id_auth_delete
+  # Deletes the webhook authentication type
+  # Updates the deleted field with the date of the deletion<br><br>
+  # @param id_auth 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :expand 
+  # @return [AuthProvider]
+  describe 'webhooks_auth_id_auth_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for webhooks_auth_id_auth_post
+  # Updates the webhook authentication type
+  # 
+  # @param id_auth 
+  # @param type The type of the authentication process (oauth, certificate, token, etc...)
+  # @param name The name of the authentication process to differentiate
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :config The authentication process configuration. A dict containing either the certificate
+  # @option opts [String] :expand 
+  # @return [AuthProvider]
+  describe 'webhooks_auth_id_auth_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for webhooks_auth_id_auth_put
+  # Updates the webhook authentication type
+  # 
+  # @param id_auth 
+  # @param type The type of the authentication process (oauth, certificate, token, etc...)
+  # @param name The name of the authentication process to differentiate
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :config The authentication process configuration. A dict containt either the certificate
+  # @option opts [String] :expand 
+  # @return [AuthProvider]
+  describe 'webhooks_auth_id_auth_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for webhooks_auth_post
+  # Adds a new webhook authentication type
+  # 
+  # @param type The type of the authentication process (oauth, certificate, token, etc...)
+  # @param name The name of the authentication process to differentiate
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :config The authentication process configuration. A dict contains either the certificate
+  # @option opts [String] :expand 
+  # @return [AuthProvider]
+  describe 'webhooks_auth_post test' do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -185,7 +355,7 @@ describe 'AdministrationApi' do
   # @option opts [String] :expand 
   # @return [Webhook]
   describe 'webhooks_delete test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -195,9 +365,21 @@ describe 'AdministrationApi' do
   # 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :expand 
-  # @return [InlineResponse20033]
+  # @return [InlineResponse20038]
   describe 'webhooks_get test' do
-    it "should work" do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for webhooks_id_webhook_add_to_data_get
+  # retrieve the list of the value to add in webhooks when sending the requested webhook
+  # 
+  # @param id_webhook 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'webhooks_id_webhook_add_to_data_get test' do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -210,7 +392,24 @@ describe 'AdministrationApi' do
   # @option opts [String] :expand 
   # @return [Webhook]
   describe 'webhooks_id_webhook_delete test' do
-    it "should work" do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for webhooks_id_webhook_logs_get
+  # Get webhooks logs.
+  # Get logs of the webhooks.<br><br>By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br>
+  # @param id_webhook 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit limit number of results
+  # @option opts [Integer] :offset offset of first result
+  # @option opts [Date] :min_date minimal (inclusive) date
+  # @option opts [Date] :max_date maximum (inclusive) date
+  # @option opts [String] :expand 
+  # @return [InlineResponse20040]
+  describe 'webhooks_id_webhook_logs_get test' do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -223,12 +422,13 @@ describe 'AdministrationApi' do
   # @option opts [String] :deleted a date to delete the webhook or 'null' to enable it
   # @option opts [Integer] :id_user The user ID to associate with the webhook
   # @option opts [Integer] :id_service The service ID to associate with the webhook
+  # @option opts [Integer] :id_auth The webhook authentication process to use
   # @option opts [Float] :url The webhook callback url
   # @option opts [String] :event The webhook event
   # @option opts [String] :expand 
   # @return [Webhook]
   describe 'webhooks_id_webhook_post test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -241,12 +441,13 @@ describe 'AdministrationApi' do
   # @option opts [String] :deleted a date to delete the webhook or 'null' to enable it
   # @option opts [Integer] :id_user The user ID to associate with the webhook
   # @option opts [Integer] :id_service The service ID to associate with the webhook
+  # @option opts [Integer] :id_auth The webhook authentication process to use
   # @option opts [Float] :url The webhook callback url
   # @option opts [String] :event The webhook event
   # @option opts [String] :expand 
   # @return [Webhook]
   describe 'webhooks_id_webhook_put test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -257,13 +458,14 @@ describe 'AdministrationApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :id_user The user ID to associate with the webhook
   # @option opts [Integer] :id_service The service ID to associate with the webhook
+  # @option opts [String] :id_auth The webhook authentication process to use (its ID or its name)
   # @option opts [Float] :url The webhook callback url
   # @option opts [String] :event The webhook event
   # @option opts [String] :params The webhook parameters as an object with three keys: type, key and value
   # @option opts [String] :expand 
   # @return [Webhook]
   describe 'webhooks_post test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end