bridge_bankin 0.1.0 → 0.1.4

data/lib/bridge_bankin/item.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Item resource (bank connector)
+  #
   class Item < BridgeObject
     RESOURCE_TYPE = "item"
 
@@ -9,38 +12,82 @@ module BridgeBankin
     class << self
       include API::Resource
 
+      #
+      # List all logged in user items
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Item>] the user items
+      #
       def list(access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/items", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/items", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # Retrieve a single item for logged in user
+      #
+      # @param [Integer] id the id of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Account] the requested user item
+      #
       def find(id:, access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/items/#{id}", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/items/#{id}", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # Trigger a refresh for a specific item
+      #
+      # @param [Integer] id the id of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [BridgeObject] the item refresh status path
+      #
       def refresh(id:, access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.post("/v2/items/#{id}/refresh", params)
-          convert_to_bridge_object(data)
+          data = api_client.post("/v2/items/#{id}/refresh", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # Request the refresh status of a specific item
+      #
+      # @param [Integer] id the id of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [BridgeObject] the user item refresh status
+      #
       def refresh_status(id:, access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/items/#{id}/refresh/status", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/items/#{id}/refresh/status", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # Delete a specific item
+      #
+      # @param [Integer] id the id of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Boolean] the request success status
+      #
       def delete(id:, access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.delete("/v2/items/#{id}", params)
-          convert_to_bridge_object(data)
+          api_client.delete("/v2/items/#{id}", **params)
+          true
         end
       end
     end

data/lib/bridge_bankin/object_types.rb

@@ -1,7 +1,15 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Supported resources types
+  #
   module ObjectTypes
+    #
+    # Matches API resources with corresponding gem classes
+    #
+    # @return [Account, Bank, Category, Item, Stock, Transaction, Transfer, User, nil] the matched resource or nil
+    #
     def self.resource_types_to_classes
       {
         Account::RESOURCE_TYPE => Account,

data/lib/bridge_bankin/stock.rb

@@ -1,25 +1,59 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Stock resource
+  #
   class Stock < BridgeObject
     RESOURCE_TYPE = "stock"
 
     class << self
       include API::Resource
 
-      def list(**params)
-        data = api_client.get("/v2/stocks", params)
-        convert_to_bridge_object(data)
+      #
+      # List all logged in user stocks
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Stock>] the user accounts
+      #
+      def list(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v2/stocks", **params)
+          convert_to_bridge_object(**data)
+        end
       end
 
-      def list_updated(**params)
-        data = api_client.get("/v2/stocks/updated", params)
-        convert_to_bridge_object(data)
+      #
+      # List all logged in user updated stocks
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Stock>] the user accounts
+      #
+      def list_updated(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v2/stocks/updated", **params)
+          convert_to_bridge_object(**data)
+        end
       end
 
-      def find(id:, **params)
-        data = api_client.get("/v2/stocks/#{id}", params)
-        convert_to_bridge_object(data)
+      #
+      # Retrieve a single stock for logged in user
+      #
+      # @param [Integer] id the id of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Account] the user accounts
+      #
+      def find(id:, access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v2/stocks/#{id}", **params)
+          convert_to_bridge_object(**data)
+        end
       end
     end
   end

data/lib/bridge_bankin/transaction.rb

@@ -1,51 +1,103 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Transaction resource
+  #
   class Transaction < BridgeObject
     RESOURCE_TYPE = "transaction"
 
     class << self
       include API::Resource
 
+      #
+      # List all logged in user transactions
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transaction>] the user transactions
+      #
       def list(access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/transactions", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/transactions", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # List all logged in user updated transactions
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transaction>] the user accounts
+      #
       def list_updated(access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/transactions/updated", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/transactions/updated", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # Retrieve a single transaction for logged in user
+      #
+      # @param [Integer] id the id of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Transaction] the user accounts
+      #
       def find(id:, access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/transactions/#{id}", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/transactions/#{id}", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # List all logged in user transactions for a specific account
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transaction>] the user accounts
+      #
       def list_by_account(account_id:, access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/accounts/#{account_id}/transactions", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/accounts/#{account_id}/transactions", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # List all logged in user updated transactions for a specific account
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transaction>] the user accounts
+      #
       def list_updated_by_account(account_id:, access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/accounts/#{account_id}/transactions/updated", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/accounts/#{account_id}/transactions/updated", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # List all logged in user transactions with a specific IBAN
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transaction>] the user accounts
+      #
       def list_by_iban(access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.post("/v2/transactions/search", params)
-          convert_to_bridge_object(data)
+          data = api_client.post("/v2/transactions/search", **params)
+          convert_to_bridge_object(**data)
         end
       end
     end

data/lib/bridge_bankin/transfer.rb

@@ -1,51 +1,104 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Transfer resource
+  #
   class Transfer < BridgeObject
     RESOURCE_TYPE = "transfert"
 
     class << self
       include API::Resource
 
+      #
+      # Request the URL to Bridge's Pay funnel to make a transfer
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [BridgeObject] the URL to Bridge's Pay funnel
+      #
       def send(access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.post("/v2/pay/transfer/url", params)
-          convert_to_bridge_object(data)
+          data = api_client.post("/v2/pay/transfer/url", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # List all logged in user transfers
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transfer>] the user's transfers
+      #
       def list(access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/transfers", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/transfers", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # Retrieve a single transfer for the logged in user
+      #
+      # @param [UUID] uuid the uuid of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Transfer] the requested transfer
+      #
       def find(uuid:, access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/transfers/#{uuid}", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/transfers/#{uuid}", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # List all sender transfer accounts
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<BridgeObject>] the user accounts
+      #
       def list_all_sender_accounts(access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/transfers/accounts/senders", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/transfers/accounts/senders", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # List all receiver transfer accounts
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<BridgeObject>] the user accounts
+      #
       def list_all_receiver_accounts(access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/transfers/accounts/receivers", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/transfers/accounts/receivers", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # List all receiver transfer accounts for a specific sender account
+      #
+      # @param [Integer] sender_account_id the sender_account_id of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<BridgeObject>] the user accounts
+      #
       def list_receiver_accounts_for_sender(sender_account_id:, access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/transfers/accounts/#{sender_account_id}/receivers", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/transfers/accounts/#{sender_account_id}/receivers", **params)
+          convert_to_bridge_object(**data)
         end
       end
     end

data/lib/bridge_bankin/user.rb

@@ -1,58 +1,130 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # User resource
+  #
   class User < BridgeObject
     RESOURCE_TYPE = "user"
 
     class << self
       include API::Resource
 
+      #
+      # List all registered users
+      #
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<User>] the registered users list
+      #
       def list(**params)
-        data = api_client.get("/v2/users", params)
-        convert_to_bridge_object(data)
+        data = api_client.get("/v2/users", **params)
+        convert_to_bridge_object(**data)
       end
 
+      #
+      # Retrieve a specific user
+      #
+      # @param [UUID] uuid the uuid of the requested resource
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [User] the requested user
+      #
       def find(uuid:, **params)
-        data = api_client.get("/v2/users/#{uuid}", params)
-        convert_to_bridge_object(data)
+        data = api_client.get("/v2/users/#{uuid}", **params)
+        convert_to_bridge_object(**data)
       end
 
+      #
+      # Create a new user
+      #
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [User] the newly created user
+      #
       def create(**params)
-        data = api_client.post("/v2/users", params)
-        convert_to_bridge_object(data)
+        data = api_client.post("/v2/users", **params)
+        convert_to_bridge_object(**data)
       end
 
+      #
+      # Update user email
+      #
+      # @param [UUID] uuid the uuid of the requested resource
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [User] the updated user
+      #
       def update_email(uuid:, **params)
-        data = api_client.put("/v2/users/#{uuid}/email", params)
-        convert_to_bridge_object(data)
+        data = api_client.put("/v2/users/#{uuid}/email", **params)
+        convert_to_bridge_object(**data)
       end
 
+      #
+      # Update user password
+      #
+      # @param [UUID] uuid the uuid of the requested resource
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [User] the updated user
+      #
       def update_password(uuid:, **params)
-        data = api_client.put("/v2/users/#{uuid}/password", params)
-        convert_to_bridge_object(data)
+        data = api_client.put("/v2/users/#{uuid}/password", **params)
+        convert_to_bridge_object(**data)
       end
 
+      #
+      # Delete a specific user
+      #
+      # @param [UUID] uuid the uuid of the requested resource
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Boolean] the request success status
+      #
       def delete_user(uuid:, **params)
-        data = api_client.delete("/v2/users/#{uuid}", params)
-        convert_to_bridge_object(data)
+        api_client.delete("/v2/users/#{uuid}", **params)
+        true
       end
 
+      #
+      # Delete all registered users
+      #
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Boolean] the request success status
+      #
       def delete_all_users(**params)
-        data = api_client.delete("/v2/users", params)
-        convert_to_bridge_object(data)
+        api_client.delete("/v2/users", **params)
+        true
       end
 
+      #
+      # Check the logged in user email confirmation status
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [BridgeObject] the user email confirmation status
+      #
       def check_email_confirmation(access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/users/me/email/confirmation", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/users/me/email/confirmation", **params)
+          convert_to_bridge_object(**data)
         end
       end
 
+      #
+      # Request the URL to access to an interface to manage the logged in user accounts' IBAN
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [BridgeObject] an URL to access to the interface to manage accounts' IBAN
+      #
       def manage_accounts(access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.get("/v2/users/manage/accounts/iban", params)
-          convert_to_bridge_object(data)
+          data = api_client.get("/v2/users/manage/accounts/iban", **params)
+          convert_to_bridge_object(**data)
         end
       end
     end