mangopay-v4 4.0.0 → 4.0.1

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

@@ -1,54 +1,54 @@
-require_relative '../uri_provider'
-
-module MangoApi
-
-  # Provides API method delegates concerning the +PayOut+ entity
-  module PayOuts
-    class << self
-      include UriProvider
-
-      # Creates a new pay-out entity.
-      #
-      # +PayOut+ properties:
-      # * Required
-      #   * author_id
-      #   * debited_funds
-      #   * fees
-      #   * bank_account_id
-      #   * debited_wallet_id
-      # * Optional
-      #   * tag
-      #   * bank_wire_ref
-      #
-      # @param +pay_out+ [PayOut] model object of the pay-out to be created
-      # @param +id_key+ [String] idempotency key for future response replication
-      # @return [PayOut] the newly-created PayOut entity object
-      def create(pay_out, id_key = nil)
-        uri = provide_uri(:create_pay_out)
-        response = HttpClient.post(uri, pay_out, id_key)
-        parse response
-      end
-
-      # Retrieves a pay-out entity.
-      #
-      # @param +id+ [String] ID of the pay-out to retrieve
-      # @return [PayOut] the requested PayOut entity object
-      def get(id)
-        uri = provide_uri(:get_pay_out, id)
-        response = HttpClient.get(uri)
-        parse response
-      end
-
-      private
-
-      # Parses a JSON-originating hash into the corresponding
-      # PayOut entity object.
-      #
-      # @param +response+ [Hash] JSON-originating data hash
-      # @return [PayOut] corresponding PayOut entity object
-      def parse(response)
-        MangoModel::PayOut.new.dejsonify response
-      end
-    end
-  end
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +PayOut+ entity
+  module PayOuts
+    class << self
+      include UriProvider
+
+      # Creates a new pay-out entity.
+      #
+      # +PayOut+ properties:
+      # * Required
+      #   * author_id
+      #   * debited_funds
+      #   * fees
+      #   * bank_account_id
+      #   * debited_wallet_id
+      # * Optional
+      #   * tag
+      #   * bank_wire_ref
+      #
+      # @param +pay_out+ [PayOut] model object of the pay-out to be created
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [PayOut] the newly-created PayOut entity object
+      def create(pay_out, id_key = nil)
+        uri = provide_uri(:create_pay_out)
+        response = HttpClient.post(uri, pay_out, id_key)
+        parse response
+      end
+
+      # Retrieves a pay-out entity.
+      #
+      # @param +id+ [String] ID of the pay-out to retrieve
+      # @return [PayOut] the requested PayOut entity object
+      def get(id)
+        uri = provide_uri(:get_pay_out, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      private
+
+      # Parses a JSON-originating hash into the corresponding
+      # PayOut entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [PayOut] corresponding PayOut entity object
+      def parse(response)
+        MangoModel::PayOut.new.dejsonify response
+      end
+    end
+  end
 end

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

@@ -1,69 +1,127 @@
-require_relative '../uri_provider'
-require_relative '../../model/request/cancel_request'
-
-module MangoApi
-
-  # Provides API method delegates concerning the +PreAuthorization+ entity
-  module PreAuthorizations
-    class << self
-      include UriProvider
-
-      # Creates a new Pre-Authorization entity.
-      #
-      # +PreAuthorization+ properties:
-      # * Required
-      #   * author_id
-      #   * debited_funds
-      #   * card_id
-      #   * secure_mode_return_url
-      # * Optional
-      #   * tag
-      #   * secure_mode
-      #
-      # @param +pre_auth+ [PreAuthorization] the pre-authorization
-      # data model object
-      # @param +id_key+ [String] idempotency key for future response replication
-      # @return [PreAuthorization] the newly-created PreAuthorization
-      # entity object
-      def create(pre_auth, id_key = nil)
-        uri = provide_uri(:create_pre_authorization)
-        response = HttpClient.post(uri, pre_auth, id_key)
-        parse response
-      end
-
-      # Retrieves a Pre-Authorization entity.
-      #
-      # @param +id+ [String] ID of the pre-authorization to retrieve
-      # @return [PreAuthorization] the requested Pre-Authorization
-      # entity object
-      def get(id)
-        uri = provide_uri(:get_pre_authorization, id)
-        response = HttpClient.get(uri)
-        parse response
-      end
-
-      # Cancels a Pre-Authorization entity.
-      #
-      # @param +id+ [String] ID of the pre-authorization to cancel
-      # @return [PreAuthorization] the requested Pre-Authorization
-      # entity object
-      def cancel(id)
-        uri = provide_uri(:cancel_pre_authorization, id)
-        cancel_request = CancelRequest.new
-        response = HttpClient.put(uri, cancel_request)
-        parse response
-      end
-
-      private
-
-      # Parses a JSON-originating hash into the corresponding
-      # PreAuthorization entity object.
-      #
-      # @param +response+ [Hash] JSON-originating data hash
-      # @return [PreAuthorization] corresponding PreAuthorization entity object
-      def parse(response)
-        MangoModel::PreAuthorization.new.dejsonify response
-      end
-    end
-  end
+require_relative '../uri_provider'
+require_relative '../../model/request/cancel_request'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +PreAuthorization+ entity
+  module PreAuthorizations
+    class << self
+      include UriProvider
+
+      # Creates a new Pre-Authorization entity.
+      #
+      # +PreAuthorization+ properties:
+      # * Required
+      #   * author_id
+      #   * debited_funds
+      #   * card_id
+      #   * secure_mode_return_url
+      # * Optional
+      #   * tag
+      #   * secure_mode
+      #
+      # @param +pre_auth+ [PreAuthorization] the pre-authorization
+      # data model object
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [PreAuthorization] the newly-created PreAuthorization
+      # entity object
+      def create(pre_auth, id_key = nil)
+        uri = provide_uri(:create_pre_authorization)
+        response = HttpClient.post(uri, pre_auth, id_key)
+        parse response
+      end
+
+      # Retrieves a Pre-Authorization entity.
+      #
+      # @param +id+ [String] ID of the pre-authorization to retrieve
+      # @return [PreAuthorization] the requested Pre-Authorization
+      # entity object
+      def get(id)
+        uri = provide_uri(:get_pre_authorization, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      # Retrieves pages of pre-authorization 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
+      # * status
+      # * result_code
+      # * payment_status
+      #
+      # @param +id+ [String] ID of the dispute whose transactions to retrieve
+      # @return [Array] the requested Transaction entity objects
+      def of_user(id)
+        uri = provide_uri(:get_users_pre_authorizations, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Cancels a Pre-Authorization entity.
+      #
+      # @param +id+ [String] ID of the pre-authorization to cancel
+      # @return [PreAuthorization] the requested Pre-Authorization
+      # entity object
+      def cancel(id)
+        uri = provide_uri(:cancel_pre_authorization, id)
+        cancel_request = CancelRequest.new
+        response = HttpClient.put(uri, cancel_request)
+        parse response
+      end
+
+      # Retrieves pre-authorization 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
+      # * result_code
+      # * status
+      # * payment_status
+      #
+      # @param +id+ [String] ID of the card whose pre-authorizations to retrieve
+      # @return [Array] corresponding PreAuthorization entity objects
+      def of_card(id)
+        uri = provide_uri(:get_preauthorizations_for_card, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      private
+
+      # Parses a JSON-originating hash into the corresponding
+      # PreAuthorization entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [PreAuthorization] corresponding PreAuthorization entity object
+      def parse(response)
+        MangoModel::PreAuthorization.new.dejsonify response
+      end
+
+      # Parses an array of JSON-originating hashes into the corresponding
+      # PreAuthorization entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] parsed PreAuthorization entity objects
+      def parse_results(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+    end
+  end
 end

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

@@ -1,62 +1,160 @@
-require_relative '../uri_provider'
-
-module MangoApi
-
-  # Provides API method delegates concerning the +Refund+ entity
-  module Refunds
-    class << self
-      include UriProvider
-
-      # Creates a Pay-In Refund, which is a request to reimburse a user
-      # on their payment card. The money which was paid will automatically
-      # go back to the user's bank account.
-      #
-      # +Refund+ properties:
-      # * Required
-      #   * author_id
-      # * Optional
-      #   * tag
-      #   * debited_funds
-      #   * fees
-      #
-      # @param +id+ [String] ID of the pay-in being refunded
-      # @param +refund+ [Refund] model object of the refund being created
-      # @param +id_key+ [String] idempotency key for future response replication
-      # @return [Refund] the newly-created Refund entity object
-      def create_for_pay_in(id, refund, id_key = nil)
-        uri = provide_uri(:create_pay_in_refund, id)
-        response = HttpClient.post(uri, refund, id_key)
-        parse response
-      end
-
-      # Creates a Transfer Refund.
-      #
-      # +Refund+ properties:
-      # * Required
-      #   * author_id
-      # * Optional
-      #   * tag
-      #
-      # @param +id+ [String] ID of the transfer being refunded
-      # @param +refund+ [Refund] model object of the refund being created
-      # @param +id_key+ [String] idempotency key for future response replication
-      # @return [Refund] the newly-created Refund entity object
-      def create_for_transfer(id, refund, id_key = nil)
-        uri = provide_uri(:create_transfer_refund, id)
-        response = HttpClient.post(uri, refund, id_key)
-        parse response
-      end
-
-      private
-
-      # Parses a JSON-originating hash into the corresponding
-      # Refund entity object.
-      #
-      # @param +response+ [Hash] JSON-originating data hash
-      # @return [Refund] corresponding Refund entity object
-      def parse(response)
-        MangoModel::Refund.new.dejsonify response
-      end
-    end
-  end
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +Refund+ entity
+  module Refunds
+    class << self
+      include UriProvider
+
+      # Creates a Pay-In Refund, which is a request to reimburse a user
+      # on their payment card. The money which was paid will automatically
+      # go back to the user's bank account.
+      #
+      # +Refund+ properties:
+      # * Required
+      #   * author_id
+      # * Optional
+      #   * tag
+      #   * debited_funds
+      #   * fees
+      #
+      # @param +id+ [String] ID of the pay-in being refunded
+      # @param +refund+ [Refund] model object of the refund being created
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [Refund] the newly-created Refund entity object
+      def create_for_pay_in(id, refund, id_key = nil)
+        uri = provide_uri(:create_pay_in_refund, id)
+        response = HttpClient.post(uri, refund, id_key)
+        parse response
+      end
+
+      # Creates a Transfer Refund.
+      #
+      # +Refund+ properties:
+      # * Required
+      #   * author_id
+      # * Optional
+      #   * tag
+      #
+      # @param +id+ [String] ID of the transfer being refunded
+      # @param +refund+ [Refund] model object of the refund being created
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [Refund] the newly-created Refund entity object
+      def create_for_transfer(id, refund, id_key = nil)
+        uri = provide_uri(:create_transfer_refund, id)
+        response = HttpClient.post(uri, refund, id_key)
+        parse response
+      end
+
+      # Retrieves pages of refund entities belonging to a certain pay-out.
+      # 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 pay-out whose refunds to retrieve
+      # @return [Array] the requested Refund entity objects
+      def of_pay_out(id)
+        uri = provide_uri(:get_payouts_refunds, 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 refund entities belonging to a certain transfer.
+      # 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 transfer whose refunds to retrieve
+      # @return [Array] the requested Refund entity objects
+      def of_transfer(id)
+        uri = provide_uri(:get_transfers_refunds, 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 refund entities belonging to a certain pay-in.
+      # 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 pay-in whose refunds to retrieve
+      # @return [Array] the requested Refund entity objects
+      def of_pay_in(id)
+        uri = provide_uri(:get_payins_refunds, 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 refund entities belonging to a certain repudiation.
+      # 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 repudiation whose refunds to retrieve
+      # @return [Array] the requested Refund entity objects
+      def of_repudiation(id)
+        uri = provide_uri(:get_repudiations_refunds, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      private
+
+      # Parses a JSON-originating hash into the corresponding
+      # Refund entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [Refund] corresponding Refund entity object
+      def parse(response)
+        MangoModel::Refund.new.dejsonify response
+      end
+
+      # Parses an Array of JSON-originating hashes into
+      # corresponding Refund entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] corresponding Refund entity objects
+      def parse_results(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+    end
+  end
 end