mangopay-v4 4.0.0 → 4.0.1

data/lib/mangopay/api/service/settlement_transfers.rb

@@ -1,55 +1,55 @@
-require_relative '../uri_provider'
-
-module MangoApi
-
-  # Provides API method delegates concerning the +SettlementTransfer+ entity
-  module SettlementTransfers
-    class << self
-      include UriProvider
-
-      # Creates a new settlement transfer entity.
-      #
-      # +SettlementTransfer+ properties:
-      # * Required
-      #   * author_id
-      #   * debited_funds
-      #   * fees
-      # * Optional
-      #   * tag
-      #
-      # @param +repudiation_id+ [String] ID of the corresponding repudiation
-      # @param +transfer+ [SettlementTransfer] model object of the settlement
-      # transfer to be created
-      # @return [SettlementTransfer] the newly-created SettlementTransfer
-      # entity object
-      def create(repudiation_id, transfer)
-        uri = provide_uri(:create_settlement_transfer, repudiation_id)
-        response = HttpClient.post(uri, transfer)
-        parse response
-      end
-
-      # Retrieves a settlement transfer entity.
-      #
-      # @param +id+ [String] ID of the settlement transfer to retrieve
-      # @return [SettlementTransfer] the requested SettlementTransfer
-      # entity object
-      def get(id)
-        uri = provide_uri(:get_settlement_transfer, id)
-        response = HttpClient.get(uri)
-        parse response
-      end
-
-      private
-
-      # Parses a JSON-originating hash into the corresponding
-      # SettlementTransfer entity object.
-      #
-      # @param +response+ [Hash] JSON-originating data hash
-      # @return [SettlementTransfer] corresponding SettlementTransfer
-      # entity object
-      def parse(response)
-        MangoModel::SettlementTransfer.new.dejsonify response
-      end
-    end
-  end
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +SettlementTransfer+ entity
+  module SettlementTransfers
+    class << self
+      include UriProvider
+
+      # Creates a new settlement transfer entity.
+      #
+      # +SettlementTransfer+ properties:
+      # * Required
+      #   * author_id
+      #   * debited_funds
+      #   * fees
+      # * Optional
+      #   * tag
+      #
+      # @param +repudiation_id+ [String] ID of the corresponding repudiation
+      # @param +transfer+ [SettlementTransfer] model object of the settlement
+      # transfer to be created
+      # @return [SettlementTransfer] the newly-created SettlementTransfer
+      # entity object
+      def create(repudiation_id, transfer)
+        uri = provide_uri(:create_settlement_transfer, repudiation_id)
+        response = HttpClient.post(uri, transfer)
+        parse response
+      end
+
+      # Retrieves a settlement transfer entity.
+      #
+      # @param +id+ [String] ID of the settlement transfer to retrieve
+      # @return [SettlementTransfer] the requested SettlementTransfer
+      # entity object
+      def get(id)
+        uri = provide_uri(:get_settlement_transfer, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      private
+
+      # Parses a JSON-originating hash into the corresponding
+      # SettlementTransfer entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [SettlementTransfer] corresponding SettlementTransfer
+      # entity object
+      def parse(response)
+        MangoModel::SettlementTransfer.new.dejsonify response
+      end
+    end
+  end
 end

data/lib/mangopay/api/service/transactions.rb

@@ -1,183 +1,247 @@
-require_relative '../uri_provider'
-
-module MangoApi
-
-  # Provides API method delegates concerning the +Transaction+ entity
-  module Transactions
-    class << self
-      include UriProvider
-
-      # Retrieves pages of transaction entities belonging to a certain user.
-      # Allows configuration of paging and sorting parameters by
-      # yielding a filtering object to a provided block. When no filters
-      # are specified, will retrieve the first page of 10 newest results.
-      #
-      # Allowed +FilterRequest+ params:
-      # * page
-      # * per_page
-      # * sort_field and sort_direction
-      # * before_date
-      # * after_date
-      # * status
-      # * nature
-      # * type
-      #
-      # @param +id+ [String] ID of the user whose transactions to retrieve
-      # @return [Array] the requested Transaction entity objects
-      def of_user(id)
-        uri = provide_uri(:get_users_transactions, id)
-        filter_request = nil
-        yield filter_request = FilterRequest.new if block_given?
-        results = HttpClient.get(uri, filter_request)
-        parse_results results
-      end
-
-      # Retrieves pages of transaction entities belonging to a certain wallet.
-      # Allows configuration of paging and sorting parameters by
-      # yielding a filtering object to a provided block. When no filters
-      # are specified, will retrieve the first page of 10 newest results.
-      #
-      # Allowed +FilterRequest+ params:
-      # * page
-      # * per_page
-      # * sort_field and sort_direction
-      # * before_date
-      # * after_date
-      # * status
-      # * nature
-      # * type
-      #
-      # @param +id+ [String] ID of the user whose transactions to retrieve
-      # @return [Array] the requested Transaction entity objects
-      def of_wallet(id)
-        uri = provide_uri(:get_wallets_transactions, id)
-        filter_request = nil
-        yield filter_request = FilterRequest.new if block_given?
-        results = HttpClient.get(uri, filter_request)
-        parse_results results
-      end
-
-      # Retrieves pages of transaction entities belonging to a certain dispute.
-      # Allows configuration of paging and sorting parameters by
-      # yielding a filtering object to a provided block. When no filters
-      # are specified, will retrieve the first page of 10 newest results.
-      #
-      # Allowed +FilterRequest+ params:
-      # * page
-      # * per_page
-      # * sort_field and sort_direction
-      # * before_date
-      # * after_date
-      # * status
-      # * nature
-      # * type
-      #
-      # @param +id+ [String] ID of the dispute whose transactions to retrieve
-      # @return [Array] the requested Transaction entity objects
-      def of_dispute(id)
-        uri = provide_uri(:get_disputes_transactions, id)
-        filter_request = nil
-        yield filter_request = FilterRequest.new if block_given?
-        results = HttpClient.get(uri, filter_request)
-        parse_results results
-      end
-
-      # Retrieves pages of transaction entities belonging to
-      # the current environment's client. Allows configuration of
-      # paging and sorting parameters by yielding a filtering object
-      # to a provided block. When no filters are specified, will
-      # retrieve the first page of 10 newest results.
-      #
-      # Allowed +FilterRequest+ params:
-      # * page
-      # * per_page
-      # * sort_field and sort_direction
-      # * before_date
-      # * after_date
-      # * status
-      # * nature
-      # * type
-      #
-      # @return [Array] the requested Transaction entity objects
-      def of_client
-        uri = provide_uri(:get_clients_transactions)
-        filter_request = nil
-        yield filter_request = FilterRequest.new if block_given?
-        results = HttpClient.get(uri, filter_request)
-        parse_results results
-      end
-
-      # Retrieves pages of transaction entities belonging to
-      # the current environment's client wallet specified by
-      # +funds_type+ and +currency+. Allows configuration of
-      # paging and sorting parameters by yielding a filtering object
-      # to a provided block. When no filters are specified, will
-      # retrieve the first page of 10 newest results.
-      #
-      # Allowed +FilterRequest+ params:
-      # * page
-      # * per_page
-      # * sort_field and sort_direction
-      # * before_date
-      # * after_date
-      # * status
-      # * nature
-      # * type
-      #
-      # @param +funds_type+ [FundsType] the funds' type of the wallet to
-      # retrieve Transactions for
-      # @return [Array] the requested Transaction entity objects
-      def of_client_wallet(funds_type, currency)
-        uri = provide_uri(:get_client_wallets_transactions,
-                          funds_type,
-                          currency)
-        filter_request = nil
-        yield filter_request = FilterRequest.new if block_given?
-        results = HttpClient.get(uri, filter_request)
-        parse_results results
-      end
-
-      # Retrieves pages of transaction entities belonging to a certain
-      # pre-authorization.Allows configuration of paging and sorting parameters
-      # by yielding a filtering object to a provided block. When no filters
-      # are specified, will retrieve the first page of 10 newest results.
-      #
-      # Allowed +FilterRequest+ params:
-      # * page
-      # * per_page
-      # * sort_field and sort_direction
-      #
-      # @param +id+ [String] ID of the dispute whose transactions to retrieve
-      # @return [Array] the requested Transaction entity objects
-      def of_pre_authorization(id)
-        uri = provide_uri(:get_pre_authorizations_transactions, id)
-        filter_request = nil
-        yield filter_request = FilterRequest.new if block_given?
-        results = HttpClient.get(uri, filter_request)
-        parse_results results
-      end
-
-      private
-
-      # Parses an array of JSON-originating hashes into the corresponding
-      # Transaction entity objects.
-      #
-      # @param +results+ [Array] JSON-originating data hashes
-      # @return [Array] parsed Transaction entity objects
-      def parse_results(results)
-        results.collect do |entity|
-          parse entity
-        end
-      end
-
-      # Parses a JSON-originating hash into the corresponding
-      # Transaction entity object.
-      #
-      # @param +response+ [Hash] JSON-originating data hash
-      # @return [Transaction] corresponding Transaction entity object
-      def parse(response)
-        MangoModel::Transaction.new.dejsonify response
-      end
-    end
-  end
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +Transaction+ entity
+  module Transactions
+    class << self
+      include UriProvider
+
+      # Retrieves pages of transaction entities belonging to a certain user.
+      # Allows configuration of paging and sorting parameters by
+      # yielding a filtering object to a provided block. When no filters
+      # are specified, will retrieve the first page of 10 newest results.
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      # * before_date
+      # * after_date
+      # * status
+      # * nature
+      # * type
+      #
+      # @param +id+ [String] ID of the user whose transactions to retrieve
+      # @return [Array] the requested Transaction entity objects
+      def of_user(id)
+        uri = provide_uri(:get_users_transactions, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Retrieves pages of transaction entities belonging to a certain wallet.
+      # Allows configuration of paging and sorting parameters by
+      # yielding a filtering object to a provided block. When no filters
+      # are specified, will retrieve the first page of 10 newest results.
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      # * before_date
+      # * after_date
+      # * status
+      # * nature
+      # * type
+      #
+      # @param +id+ [String] ID of the user whose transactions to retrieve
+      # @return [Array] the requested Transaction entity objects
+      def of_wallet(id)
+        uri = provide_uri(:get_wallets_transactions, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Retrieves pages of transaction entities belonging to a certain dispute.
+      # Allows configuration of paging and sorting parameters by
+      # yielding a filtering object to a provided block. When no filters
+      # are specified, will retrieve the first page of 10 newest results.
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      # * before_date
+      # * after_date
+      # * status
+      # * nature
+      # * type
+      #
+      # @param +id+ [String] ID of the dispute whose transactions to retrieve
+      # @return [Array] the requested Transaction entity objects
+      def of_dispute(id)
+        uri = provide_uri(:get_disputes_transactions, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Retrieves pages of transaction entities belonging to
+      # the current environment's client. Allows configuration of
+      # paging and sorting parameters by yielding a filtering object
+      # to a provided block. When no filters are specified, will
+      # retrieve the first page of 10 newest results.
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      # * before_date
+      # * after_date
+      # * status
+      # * nature
+      # * type
+      #
+      # @return [Array] the requested Transaction entity objects
+      def of_client
+        uri = provide_uri(:get_clients_transactions)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Retrieves pages of transaction entities belonging to
+      # the current environment's client wallet specified by
+      # +funds_type+ and +currency+. Allows configuration of
+      # paging and sorting parameters by yielding a filtering object
+      # to a provided block. When no filters are specified, will
+      # retrieve the first page of 10 newest results.
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      # * before_date
+      # * after_date
+      # * status
+      # * nature
+      # * type
+      #
+      # @param +funds_type+ [FundsType] the funds' type of the wallet to
+      # retrieve Transactions for
+      # @return [Array] the requested Transaction entity objects
+      def of_client_wallet(funds_type, currency)
+        uri = provide_uri(:get_client_wallets_transactions,
+                          funds_type,
+                          currency)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Retrieves pages of transaction entities belonging to a certain
+      # pre-authorization. Allows configuration of paging and sorting parameters
+      # by yielding a filtering object to a provided block. When no filters
+      # are specified, will retrieve the first page of 10 newest results.
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      #
+      # @param +id+ [String] ID of the dispute whose transactions to retrieve
+      # @return [Array] the requested Transaction entity objects
+      def of_pre_authorization(id)
+        uri = provide_uri(:get_pre_authorizations_transactions, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+      
+      # Retrieves pages of card entities belonging to a certain card.
+      # Allows configuration of paging and sorting parameters by yielding
+      # a filtering object to a provided block. When no filters are specified,
+      # will retrieve the first page of 10 newest results.
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      # * status
+      # * result_code
+      #
+      # @param +id+ [String] ID of the card whose transactions to retrieve
+      # @return [Array] the requested Transaction entity objects
+      def of_card(id)
+        uri = provide_uri(:get_cards_transactions, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Retrieves pages of transaction entities belonging to a certain
+      # bank account. Allows configuration of paging and sorting parameters
+      # by yielding a filtering object to a provided block. When no filters
+      # are specified, will retrieve the first page of 10 newest results.
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      # * status
+      # * result_code
+      #
+      # @param +id+ [String] ID of the bank account whose transactions to retrieve
+      # @return [Array] the requested Transaction entity objects
+      def of_bank_account(id)
+        uri = provide_uri(:get_bank_accounts_transactions, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Retrieves pages of transaction entities belonging to a certain
+      # mandate. Allows configuration of paging and sorting parameters
+      # by yielding a filtering object to a provided block. When no filters
+      # are specified, will retrieve the first page of 10 newest results.
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      #
+      # @param +id+ [String] ID of the mandate whose transactions to retrieve
+      # @return [Array] the requested Transaction entity objects
+      def of_mandate(id)
+        uri = provide_uri(:get_mandates_transactions, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      private
+
+      # Parses an array of JSON-originating hashes into the corresponding
+      # Transaction entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] parsed Transaction entity objects
+      def parse_results(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+
+      # Parses a JSON-originating hash into the corresponding
+      # Transaction entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [Transaction] corresponding Transaction entity object
+      def parse(response)
+        MangoModel::Transaction.new.dejsonify response
+      end
+    end
+  end
 end