mangopay-v4 4.0.0

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

@@ -0,0 +1,69 @@
+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
+end

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

@@ -0,0 +1,62 @@
+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
+end

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

@@ -0,0 +1,151 @@
+require_relative '../uri_provider'
+require_relative '../../model/report_filter'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +Report+ entity
+  module Reports
+    class << self
+      include UriProvider
+
+      # Requests creation of a transaction report.
+      # Yields a +ReportFilter+ object for caller to specify
+      # filtering parameters in a provided block.
+      #
+      # +Report+ properties:
+      # * Optional
+      #   * tag
+      #   * callback_url
+      #   * download_format
+      #   * sort
+      #   * preview
+      #   * columns
+      #
+      # Available +columns+ values: Alias, AuthorId,
+      # BankAccountId, BankWireRef, CardId, CardType, Country,
+      # CreationDate, CreditedFundsAmount, CreditedFundsCurrency,
+      # CreditedUserId, CreditedWalletId, Culture, DebitedFundsAmount,
+      # DebitedFundsCurrency, DebitedWalletId, DeclaredDebitedFundsAmount,
+      # DeclaredDebitedFundsCurrency, DeclaredFeesAmount, DeclaredFeesCurrency,
+      # ExecutionDate, ExecutionType, ExpirationDate, FeesAmount, FeesCurrency,
+      # Id, Nature, PaymentType, PreauthorizationId, ResultCode, ResultMessage,
+      # Status, Tag, Type, WireReference
+      #
+      # Allowed +ReportFilter+ params:
+      # * after_date
+      # * before_date
+      # * type
+      # * status
+      # * nature
+      # * min_debited_funds_amount
+      # * min_debited_funds_currency
+      # * max_debited_funds_amount
+      # * max_debited_funds_currency
+      # * min_fees_amount
+      # * min_fees_currency
+      # * max_fees_amount
+      # * max_fees_currency
+      # * author_id
+      # * wallet_id
+      #
+      # @param +report+ [Report] model object of the report to be created
+      # @return [Report] the newly-created Report entity object
+      def create_for_transactions(report)
+        uri = provide_uri(:create_transaction_report)
+        report.filters = ReportFilter.new unless report.filters
+        yield report.filters if block_given?
+        response = HttpClient.post(uri, report)
+        parse response
+      end
+
+      # Requests creation of a wallet report.
+      # Yields a +ReportFilter+ object for caller to specify
+      # filtering parameters in a provided block.
+      #
+      # +Report+ properties:
+      # * Optional
+      #   * tag
+      #   * callback_url
+      #   * download_format
+      #   * sort
+      #   * preview
+      #   * columns
+      #
+      # Available +columns+ values: Id, Tag, CreationDate, Owners, Description,
+      # BalanceAmount, BalanceCurrency, Currency, FundsType
+      #
+      # Allowed +FilterRequest+ params:
+      # * after_date
+      # * before_date
+      # * owner_id
+      # * currency
+      # * min_balance_amount
+      # * min_balance_currency
+      # * max_balance_amount
+      # * max_balance_currency
+      #
+      # @param +report+ [Report] model object of the report to be created
+      # @return [Report] the newly-created Report entity object
+      def create_for_wallets(report)
+        uri = provide_uri(:create_wallet_report)
+        report.filters = ReportFilter.new unless report.filters
+        yield report.filters if block_given?
+        response = HttpClient.post(uri, report)
+        parse response
+      end
+
+      # Retrieves a report entity.
+      #
+      # @param +id+ [String] ID of the report to retrieve
+      # @return [Report] the requested Report entity object
+      def get(id)
+        uri = provide_uri(:get_report, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      # Retrieves report entities. 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
+      #
+      # @return [Array] corresponding Report entity objects
+      def all
+        uri = provide_uri(:get_reports)
+        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
+      # Report entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] parsed Report entity objects
+      def parse_results(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+
+      # Parses a JSON-originating hash into the corresponding
+      # Report entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [Report] corresponding Report entity object
+      def parse(response)
+        MangoModel::Report.new.dejsonify response
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +Repudiation+ entity
+  module Repudiations
+    class << self
+      include UriProvider
+
+      # Retrieves a repudiation entity.
+      #
+      # @param +id+ [String] ID of the repudiation to retrieve
+      # @return [Repudiation] the requested Repudiation entity object
+      def get(id)
+        uri = provide_uri(:get_repudiation, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      private
+
+      # Parses a JSON-originating hash into the corresponding
+      # Repudiation entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [Repudiation] corresponding Repudiation entity object
+      def parse(response)
+        MangoModel::Repudiation.new.dejsonify response
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+require_relative '../uri_provider'
+require_relative '../../model/response_replica'
+
+module MangoApi
+
+  # Provides API method delegates for replicating
+  # responses based on idempotency keys.
+  module Responses
+    class << self
+      include UriProvider
+
+      # Retrieves the response of a previous request by
+      # the idempotency key which was provided at the time.
+      #
+      # @param +id_key+ Idempotency key provided with the original request
+      # @return [ResponseReplica] Replica of the original response
+      def replicate(id_key)
+        uri = provide_uri(:replicate_response, id_key)
+        response = HttpClient.get uri
+        parse response
+      end
+
+      private
+
+      # Parses the received response into a corresponding object
+      #
+      # @param +response+ [Hash] hashed response
+      # @return [ResponseReplica] De-serialized typed response replication
+      def parse(response)
+        replica = MangoModel::ResponseReplica.new.dejsonify response
+        type = entity_type(replica.resource, replica.request_url)
+        replica.resource = type.new.dejsonify replica.resource if type
+        replica
+      end
+
+      # Asserts the effective type of entity returned
+      # in an API response, based on the request URL.
+      #
+      # @param +hash+ [Hash] hashed JSON response
+      # @param +source_url+ [String] URL from where the entity was returned
+      # @return [Class] actual type of the entity
+      def entity_type(hash, source_url)
+        case source_url
+        when %r{/reports}
+          MangoModel::Report
+        when %r{(/settlementtransfer|/settlements)}
+          MangoModel::SettlementTransfer
+        when %r{/repudiations}
+          MangoModel::Repudiation
+        when %r{(/disputes.+/documents|dispute-documents)}
+          MangoModel::DisputeDocument
+        when %r{/disputes}
+          MangoModel::Dispute
+        when %r{(/kyc/documents.+/consult|/dispute-documents.+/consult)}
+          MangoModel::DocumentPageConsult
+        when %r{/refunds}
+          MangoModel::Refund
+        when %r{/events}
+          MangoModel::Event
+        when %r{/hooks}
+          MangoModel::Hook
+        when %r{/ubodeclarations}
+          MangoModel::UboDeclaration
+        when %r{/kyc/documents}
+          MangoModel::KycDocument
+        when %r{/payouts/}
+          MangoModel::PayOut
+        when %r{/extended/}
+          MangoModel::PayInWebExtendedView
+        when %r{/mandates}
+          MangoModel:: Mandate
+        when %r{/transactions}
+          MangoModel::Transaction
+        when %r{/preauthorizations}
+          MangoModel::PreAuthorization
+        when %r{/cards}
+          MangoModel::Card
+        when %r{/cardregistrations}
+          MangoModel::CardRegistration
+        when %r{/payins}
+          MangoModel.pay_in_type(hash)
+        when %r{/transfers}
+          MangoModel::Transfer
+        when %r{/emoney}
+          MangoModel::EMoney
+        when %r{/bankaccounts}
+          MangoModel.bank_account_type(hash)
+        when %r{/clients/wallets}
+          MangoModel::ClientWallet
+        when %r{/wallets}
+          MangoModel::Wallet
+        when %r{/users}
+          MangoModel.user_type(hash)
+        when %r{/clients}
+          MangoModel::Client
+        else
+          raise 'Could not assert effective type for entity source: ' + source_url
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +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
+end