bridgeapi_client 1.0.1

data/lib/bridge_api/item.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module BridgeApi
+  #
+  # Item resource (bank connector)
+  #
+  class Item < BridgeObject
+    RESOURCE_TYPE = "item"
+
+    # TODO: Add support of item statuses
+
+    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("/v3/aggregation/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("/v3/aggregation/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)
+        warn "BridgeApi::Item.refresh is deprecated."
+        super
+      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)
+        warn "BridgeApi::Item.refresh_status is deprecated."
+        super
+      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
+          api_client.delete("/v3/aggregation/items/#{id}", **params)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/bridge_api/object_types.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module BridgeApi
+  #
+  # 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,
+        Bank::RESOURCE_TYPE => Bank,
+        Provider::RESOURCE_TYPE => Provider,
+        Category::RESOURCE_TYPE => Category,
+        Item::RESOURCE_TYPE => Item,
+        Stock::RESOURCE_TYPE => Stock,
+        Transaction::RESOURCE_TYPE => Transaction,
+        Transfer::RESOURCE_TYPE => Transfer,
+        Payment::RESOURCE_TYPE => Payment,
+        User::RESOURCE_TYPE => User
+      }
+    end
+  end
+end

data/lib/bridge_api/payment.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+module BridgeApi
+  #
+  # Payment resource
+  #
+  class Payment < BridgeObject
+    RESOURCE_TYPE = "payment"
+
+    class << self
+      include API::Resource
+
+      #
+      # Payment Links
+      #
+
+      #
+      # Create a new payment link
+      #
+      # @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 created payment link
+      #
+      def create_payment_link(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.post("/v3/payment/payment-links", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # List all payment links
+      #
+      # @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 list of payment links
+      #
+      def list_payment_links(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v3/payment/payment-links", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # Get a single payment link
+      #
+      # @param [String] id the id of the payment link
+      # @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 requested payment link
+      #
+      def get_payment_link(id:, access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v3/payment/payment-links/#{id}", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # Revoke a payment link
+      #
+      # @param [String] id the id of the payment link
+      # @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 revoked payment link
+      #
+      def revoke_payment_link(id:, access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.post("/v3/payment/payment-links/#{id}/revoke", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # Payment Requests
+      #
+
+      #
+      # Create a new payment request
+      #
+      # @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 created payment request
+      #
+      def create_payment_request(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.post("/v3/payment/payment-requests", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # List all payment requests
+      #
+      # @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 list of payment requests
+      #
+      def list_payment_requests(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v3/payment/payment-requests", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # Get a single payment request
+      #
+      # @param [String] id the id of the payment request
+      # @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 requested payment request
+      #
+      def get_payment_request(id:, access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v3/payment/payment-requests/#{id}", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # Payment Consents
+      #
+
+      #
+      # Create a payment consent
+      #
+      # @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 created payment consent
+      #
+      def create_payment_consent(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.post("/v3/payment/consents", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # Payment Account
+      #
+
+      #
+      # Create a refund
+      #
+      # @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 created refund
+      #
+      def create_refund(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.post("/v3/payment/refunds", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # List refunds
+      #
+      # @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 list of refunds
+      #
+      def list_refunds(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v3/payment/refunds", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # Get a single refund
+      #
+      # @param [String] id the id of the refund
+      # @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 requested refund
+      #
+      def get_refund(id:, access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v3/payment/refunds/#{id}", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # List beneficiaries
+      #
+      # @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 list of beneficiaries
+      #
+      def list_beneficiaries(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v3/payment/beneficiaries", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # Create a payout
+      #
+      # @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 created payout
+      #
+      def create_payout(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.post("/v3/payment/payouts", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # List payouts
+      #
+      # @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 list of payouts
+      #
+      def list_payouts(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v3/payment/payouts", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # Get a single payout
+      #
+      # @param [String] id the id of the payout
+      # @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 requested payout
+      #
+      def get_payout(id:, access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v3/payment/payouts/#{id}", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+    end
+  end
+end

data/lib/bridge_api/provider.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module BridgeApi
+  #
+  # Provider resource (formerly Bank)
+  #
+  class Provider < BridgeObject
+    RESOURCE_TYPE = "provider"
+
+    class << self
+      include API::Resource
+
+      #
+      # List all providers supported by the Bridge API
+      #
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Provider>] the supported providers list
+      #
+      def list(**params)
+        data = api_client.get("/v3/providers", **params)
+        convert_to_bridge_object(**data)
+      end
+
+      #
+      # Retrieve a single provider
+      #
+      # @param [Integer] id the id of the requested resource
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Provider] the requested provider
+      #
+      def find(id:, **params)
+        data = api_client.get("/v3/providers/#{id}", **params)
+        convert_to_bridge_object(**data)
+      end
+    end
+  end
+end
+

data/lib/bridge_api/resources.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bridge_api/authorization"
+require "bridge_api/account"
+require "bridge_api/category"
+require "bridge_api/stock"
+require "bridge_api/provider"
+require "bridge_api/bank"
+require "bridge_api/user"
+require "bridge_api/connect"
+require "bridge_api/item"
+require "bridge_api/transaction"
+require "bridge_api/payment"
+require "bridge_api/transfer"
+require "bridge_api/insight"

data/lib/bridge_api/stock.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module BridgeApi
+  #
+  # Stock resource
+  #
+  class Stock < BridgeObject
+    RESOURCE_TYPE = "stock"
+
+    class << self
+      include API::Resource
+
+      #
+      # 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("/v3/aggregation/stocks", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # 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("/v3/aggregation/stocks/#{id}", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+    end
+  end
+end

data/lib/bridge_api/transaction.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module BridgeApi
+  #
+  # 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("/v3/aggregation/transactions", **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 requested transaction
+      #
+      def find(id:, access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v3/aggregation/transactions/#{id}", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      #
+      # List all logged in user transactions for a specific account
+      #
+      # @param [Integer] account_id the account id
+      # @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 for the account
+      #
+      def list_by_account(account_id:, access_token:, **params)
+        protected_resource(access_token) do
+          params[:account_ids] = account_id
+          data = api_client.get("/v3/aggregation/transactions", **params)
+          convert_to_bridge_object(**data)
+        end
+      end
+
+      # Deprecated methods
+
+      def list_updated(access_token:, **params)
+        warn "BridgeApi::Transaction.list_updated is deprecated. Use BridgeApi::Transaction.list with since parameter instead."
+        list(access_token: access_token, **params)
+      end
+
+      def list_updated_by_account(account_id:, access_token:, **params)
+        warn "BridgeApi::Transaction.list_updated_by_account is deprecated. Use BridgeApi::Transaction.list_by_account with since parameter instead."
+        list_by_account(account_id: account_id, access_token: access_token, **params)
+      end
+
+      def list_by_iban(access_token:, **params)
+        warn "BridgeApi::Transaction.list_by_iban is deprecated. Use BridgeApi::Transaction.list with filters instead."
+        list(access_token: access_token, **params)
+      end
+    end
+  end
+end

data/lib/bridge_api/transfer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module BridgeApi
+  #
+  # Transfer resource is deprecated, use Payment instead
+  #
+  class Transfer < Payment
+    RESOURCE_TYPE = "transfert"
+
+    class << self
+      def send(access_token:, **params)
+        warn "BridgeApi::Transfer.send is deprecated. Use BridgeApi::Payment.create_payment_link instead."
+        create_payment_link(access_token: access_token, **params)
+      end
+
+      def list(access_token:, **params)
+        warn "BridgeApi::Transfer.list is deprecated. Use BridgeApi::Payment.list_payment_requests instead."
+        list_payment_requests(access_token: access_token, **params)
+      end
+
+      def find(uuid:, access_token:, **params)
+        warn "BridgeApi::Transfer.find is deprecated. Use BridgeApi::Payment.get_payment_request instead."
+        get_payment_request(id: uuid, access_token: access_token, **params)
+      end
+
+      def list_all_sender_accounts(access_token:, **params)
+        warn "BridgeApi::Transfer.list_all_sender_accounts is deprecated."
+        {}
+      end
+
+      def list_all_receiver_accounts(access_token:, **params)
+        warn "BridgeApi::Transfer.list_all_receiver_accounts is deprecated. Use BridgeApi::Payment.list_beneficiaries instead."
+        list_beneficiaries(access_token: access_token, **params)
+      end
+
+      def list_receiver_accounts_for_sender(sender_account_id:, access_token:, **params)
+        warn "BridgeApi::Transfer.list_receiver_accounts_for_sender is deprecated. Use BridgeApi::Payment.list_beneficiaries instead."
+        list_beneficiaries(access_token: access_token, **params)
+      end
+    end
+  end
+end