mangopay-v4 4.0.0

data/lib/mangopay/model/event.rb

@@ -0,0 +1,18 @@
+require_relative '../common/jsonifier'
+
+module MangoModel
+
+  # The Event entity
+  class Event
+    include MangoPay::Jsonifier
+
+    # [String] Its ID
+    attr_accessor :resource_id
+
+    # [Integer] Time when the event happened (UNIX timestamp)
+    attr_accessor :date
+
+    # [EventType] Its type
+    attr_accessor :event_type
+  end
+end

data/lib/mangopay/model/model.rb

@@ -0,0 +1,194 @@
+require 'date'
+require_relative 'entity/entity_base'
+require_relative 'enum/country_iso'
+require_relative 'enum/person_type'
+require_relative 'enum/legal_person_type'
+require_relative 'enum/income_range'
+require_relative 'enum/kyc_level'
+require_relative 'enum/deposit_type'
+require_relative 'enum/currency_iso'
+require_relative 'enum/funds_type'
+require_relative 'enum/platform_type'
+require_relative 'enum/account_type'
+require_relative 'enum/transaction_type'
+require_relative 'enum/transaction_nature'
+require_relative 'enum/transaction_status'
+require_relative 'enum/pay_in_payment_type'
+require_relative 'enum/pay_in_execution_type'
+require_relative 'enum/card_type'
+require_relative 'enum/secure_mode'
+require_relative 'enum/culture_code'
+require_relative 'enum/card_status'
+require_relative 'enum/card_validity'
+require_relative 'enum/pre_authorization_status'
+require_relative 'enum/pre_authorization_execution_type'
+require_relative 'enum/payment_status'
+require_relative 'enum/direct_debit_type'
+require_relative 'enum/mandate_scheme'
+require_relative 'enum/mandate_status'
+require_relative 'enum/mandate_type'
+require_relative 'enum/mandate_execution_type'
+require_relative 'enum/pay_out_payment_type'
+require_relative 'enum/kyc_doc_refused_reason_type'
+require_relative 'enum/kyc_document_type'
+require_relative 'enum/document_status'
+require_relative 'enum/natural_user_capacity'
+require_relative 'enum/ubo_declaration_status'
+require_relative 'enum/ubo_declaration_refused_reason_type'
+require_relative 'enum/declared_ubo_status'
+require_relative 'enum/declared_ubo_refused_reason_type'
+require_relative 'enum/hook_validity'
+require_relative 'enum/event_type'
+require_relative 'enum/refund_reason_type'
+require_relative 'enum/dispute_type'
+require_relative 'enum/dispute_reason_type'
+require_relative 'enum/dispute_status'
+require_relative 'enum/dispute_doc_refused_reason_type'
+require_relative 'enum/download_format'
+require_relative 'enum/report_type'
+require_relative 'enum/report_status'
+require_relative 'entity/user/user'
+require_relative 'entity/user/natural_user'
+require_relative 'entity/user/legal_user'
+require_relative 'entity/card'
+require_relative 'entity/client'
+require_relative 'entity/transaction'
+require_relative 'entity/transfer'
+require_relative 'entity/pre_authorization'
+require_relative 'entity/repudiation'
+require_relative 'entity/settlement_transfer'
+require_relative 'event'
+require_relative 'address'
+require_relative 'money'
+require_relative 'entity/wallet'
+require_relative 'e_money'
+require_relative 'refund_reason'
+require_relative 'document_page_consult'
+require_relative 'dispute_reason'
+
+# Module for model classes.
+module MangoModel
+
+  # Maps each type to its existing declared field names.
+  @fields_by_type = {
+    DateTime => %w[date],
+    PersonType => %w[person_type],
+    KycLevel => %w[kyc_level],
+    LegalPersonType => %w[legal_person_type],
+    CountryIso => %w[country
+                     nationality
+                     country_of_residence
+                     legal_representative_nationality
+                     legal_representative_country_of_residence],
+    Address => %w[address
+                  headquarters_address
+                  legal_representative_address
+                  owner_address],
+    DepositType => %w[deposit_account_type],
+    Money => %w[balance
+                credited_e_money
+                debited_e_money
+                debited_funds
+                credited_funds
+                fees
+                declared_debited_funds
+                declared_fees
+                disputed_funds
+                contested_funds],
+    CurrencyIso => %w[currency],
+    FundsType => %w[funds_type],
+    PlatformType => %w[platform_type],
+    TransactionNature => %w[nature],
+    TransactionStatus => %w[status],
+    TransactionType => %w[type initial_transaction_type],
+    PayInPaymentType => %w[payment_type],
+    PayInExecutionType => %w[execution_type],
+    CardType => %w[card_type],
+    SecureMode => %w[secure_mode],
+    CultureCode => %w[culture],
+    CardValidity => %w[validity],
+    PaymentStatus => %w[payment_status],
+    DirectDebitType => %w[direct_debit_type],
+    MandateScheme => %w[scheme],
+    MandateType => %w[mandate_type],
+    KycDocRefusedReasonType => %w[refused_reason_type],
+    NaturalUserCapacity => %w[capacity],
+    EventType => %w[event_type],
+    RefundReason => %w[refund_reason],
+    RefundReasonType => %w[refund_reason_type],
+    DisputeType => %w[dispute_type],
+    DisputeReason => %w[dispute_reason],
+    DisputeReasonType => %w[dispute_reason_type],
+    DownloadFormat => %w[download_format],
+    ReportType => %w[report_type]
+  }
+
+  class << self
+
+    # Returns an array containing all declared
+    # field names of a certain type
+    #
+    # noinspection RubyResolve
+    def fields_of_type(type)
+      @fields_by_type[type]
+    end
+
+    # Asserts the type of pay-in represented by a hash
+    #
+    # @param +hash+ [Hash] source hash
+    # @return [Class] type of pay-in represented by the hash
+    def pay_in_type(hash)
+      if hash['PaymentType'] == PayInPaymentType::CARD.to_s\
+        && hash['ExecutionType'] == PayInExecutionType::WEB.to_s
+        CardWebPayIn
+      elsif hash['PaymentType'] == PayInPaymentType::CARD.to_s\
+        && hash['ExecutionType'] == PayInExecutionType::DIRECT.to_s
+        CardDirectPayIn
+      elsif hash['PaymentType'] == PayInPaymentType::PREAUTHORIZED.to_s\
+        && hash['ExecutionType'] == PayInExecutionType::DIRECT.to_s
+        CardPreAuthorizedPayIn
+      elsif hash['PaymentType'] == PayInPaymentType::BANK_WIRE.to_s\
+        && hash['ExecutionType'] == PayInExecutionType::DIRECT.to_s
+        BankWireDirectPayIn
+      elsif hash['PaymentType'] == PayInPaymentType::DIRECT_DEBIT.to_s\
+        && hash['ExecutionType'] == PayInExecutionType::WEB.to_s
+        DirectDebitWebPayIn
+      elsif hash['PaymentType'] == PayInPaymentType::DIRECT_DEBIT.to_s\
+        && hash['ExecutionType'] == PayInExecutionType::DIRECT.to_s
+        DirectDebitDirectPayIn
+      end
+    end
+
+    # Asserts the type of bank account represented by a hash.
+    #
+    # @param +hash+ [Hash] source hash
+    # @return [Class] type of bank account represented by the hash
+    def bank_account_type(hash)
+      case hash['Type']
+        when AccountType::IBAN.to_s
+          IbanBankAccount
+        when AccountType::US.to_s
+          UsBankAccount
+        when AccountType::CA.to_s
+          CaBankAccount
+        when AccountType::GB.to_s
+          GbBankAccount
+        else
+          OtherBankAccount
+      end
+    end
+
+    # Asserts the type of user represented by a hash.
+    #
+    # @param +hash+ [Hash] source hash
+    # @return [Class] type of user represented by the hash
+    def user_type(hash)
+      case hash['PersonType']
+        when PersonType::NATURAL.to_s
+          NaturalUser
+        else
+          LegalUser
+      end
+    end
+  end
+end

data/lib/mangopay/model/money.rb

@@ -0,0 +1,17 @@
+require_relative '../common/jsonifier'
+
+module MangoModel
+
+  # Models a financial sum
+  class Money
+    include MangoPay::Jsonifier
+
+    # [CurrencyIso] Currency in which the sum is represented
+    attr_accessor :currency
+
+    # [Integer] The amount of money in the smallest sub-division of the currency
+    #           e.g. 12.60 EUR would be represented as 1260 whereas 12 JPY
+    # would be represented as just 12
+    attr_accessor :amount
+  end
+end

data/lib/mangopay/model/pay_in_web_extended_view.rb

@@ -0,0 +1,31 @@
+require_relative '../common/jsonifier'
+
+module MangoModel
+
+  # The Pay-In Web Extended View is an object which provides
+  # more details about the card used to process a Web Pay-In
+  class PayInWebExtendedView
+    include MangoPay::Jsonifier
+
+    # [String] The item's ID
+    attr_accessor :id
+
+    # [PayInPaymentType] The type of pay-in
+    attr_accessor :payment_type
+
+    # [Integer] Time when the transaction happened (UNIX timestamp)
+    attr_accessor :execution_date
+
+    # [String] The expiry date of the card (MMYY format)
+    attr_accessor :expiration_date
+
+    # [String] A partially obfuscated version of the credit card number
+    attr_accessor :alias
+
+    # [CardType] The type of card
+    attr_accessor :card_type
+
+    # [CountryIso] Country of the address
+    attr_accessor :country
+  end
+end

data/lib/mangopay/model/refund_reason.rb

@@ -0,0 +1,15 @@
+require_relative '../common/jsonifier'
+
+module MangoModel
+
+  # Reason for a refund
+  class RefundReason
+    include MangoPay::Jsonifier
+
+    # [RefundReasonType] Type of reason for refusal
+    attr_accessor :refused_reason_type
+
+    # [String] Message accompanying a refusal
+    attr_accessor :refused_reason_message
+  end
+end

data/lib/mangopay/model/report_filter.rb

@@ -0,0 +1,83 @@
+require_relative '../common/jsonifier'
+
+# Filtering object for reports
+class ReportFilter
+  include MangoPay::Jsonifier
+
+  #
+  # COMMON
+  #
+
+  # [Integer] Only include resources with CreationDate
+  # before this time (UNIX timestamp)
+  attr_accessor :before_date
+
+  # [Integer] Only include resources with CreationDate
+  # after this time (UNIX timestamp)
+  attr_accessor :after_date
+
+  #
+  # TRANSACTION
+  #
+
+  # [Array] Only include transactions of these +TransactionType+s
+  attr_accessor :type
+
+  # [Array] Only include transactions with these +TransactionStatus+es
+  attr_accessor :status
+
+  # [Array] Only include transactions of these +TransactionNature+s
+  attr_accessor :nature
+
+  # [Integer] The minimum amount of debited funds
+  attr_accessor :min_debited_funds_amount
+
+  # [CurrencyIso] The currency of minimum debited funds
+  attr_accessor :min_debited_funds_currency
+
+  # [Integer] The maximum amount of debited funds
+  attr_accessor :max_debited_funds_amount
+
+  # [CurrencyIso] The currency of maximum debited funds
+  attr_accessor :max_debited_funds_currency
+
+  # [Integer] The minimum amount of fees
+  attr_accessor :min_fees_amount
+
+  # [CurrencyIso] The currency of minimum fees
+  attr_accessor :min_fees_currency
+
+  # [Integer] The maximum amount of fees
+  attr_accessor :max_fees_amount
+
+  # [CurrencyIso] The currency of maximum fees
+  attr_accessor :max_fees_currency
+
+  # [String] Only include resources with this author ID
+  attr_accessor :author_id
+
+  # [String] Only include resources with this wallet ID
+  attr_accessor :wallet_id
+
+  #
+  # WALLET
+  #
+
+  # [String] Only include wallets having owner with this ID
+  attr_accessor :owner_id
+
+  # [CurrencyIso] Only include wallets of this currency
+  attr_accessor :currency
+
+  # [Integer] The minimum balance of wallets to include
+  attr_accessor :min_balance_amount
+
+  # [CurrencyIso] The currency of minimum balance
+  attr_accessor :min_balance_currency
+
+  # [Integer] The maximum balance of wallets to include
+  attr_accessor :max_balance_amount
+
+  # [CurrencyIso] The currency of maximum balance
+  attr_accessor :max_balance_currency
+end

data/lib/mangopay/model/request/cancel_request.rb

@@ -0,0 +1,16 @@
+require_relative '../../common/jsonifier'
+
+# Model object of request to cancel an action
+class CancelRequest
+  include MangoPay::Jsonifier
+
+  # [String] Custom data to add with the operation
+  attr_accessor :tag
+
+  # [PaymentStatus] +CANCELED+ payment status
+  attr_accessor :payment_status
+
+  def initialize
+    self.payment_status = MangoModel::PaymentStatus::CANCELED
+  end
+end

data/lib/mangopay/model/request/complete_registration_request.rb

@@ -0,0 +1,13 @@
+require_relative '../../common/jsonifier'
+
+# Model object for body of request to complete a card registration
+class CompleteRegistrationRequest
+  include MangoPay::Jsonifier
+
+  # [String] Registration key received from the Tokenization Server
+  attr_accessor :registration_data
+
+  def initialize(registration_data)
+    self.registration_data = registration_data
+  end
+end

data/lib/mangopay/model/request/currency_request.rb

@@ -0,0 +1,13 @@
+require_relative '../../common/jsonifier'
+
+# Model object for body of request to represent results in a certain currency.
+class CurrencyRequest
+  include MangoPay::Jsonifier
+
+  # [CurrencyIso] the currency in which to represent results
+  attr_accessor :currency
+
+  def initialize(currency)
+    self.currency = currency
+  end
+end

data/lib/mangopay/model/request/deactivation_request.rb

@@ -0,0 +1,10 @@
+require_relative '../../common/jsonifier'
+
+# Model object for body of request to deactivate a bank account
+class DeactivationRequest
+  include MangoPay::Jsonifier
+
+  def initialize
+    @active = false
+  end
+end

data/lib/mangopay/model/request/filter_request.rb

@@ -0,0 +1,38 @@
+# Requests filtering of response lists
+class FilterRequest
+
+  # [Integer] Number of the page of results to be retrieved
+  attr_accessor :page
+
+  # [Integer] Number of results to be included per page
+  attr_accessor :per_page
+
+  # [SortField] Field by which to sort results
+  attr_accessor :sort_field
+
+  # [SortDirection] Direction of sorting by specified field
+  attr_accessor :sort_direction
+
+  # [Integer] Maximum creation date of result entities
+  attr_accessor :before_date
+
+  # [Integer] Minimum creation date of result entities
+  attr_accessor :after_date
+
+  # [DocumentStatus/TransactionStatus/DisputeStatus] Status of entities
+  # to be retrieved
+  attr_accessor :status
+
+  # [TransactionNature] Nature of transaction entities to be retrieved
+  attr_accessor :nature
+
+  # [TransactionType/DisputeDocumentType] Type of entities to be retrieved
+  attr_accessor :type
+
+  # [DisputeType] Type of dispute entities to be retrieved
+  attr_accessor :dispute_type
+
+  # [EventType] Type of events to be retrieved
+  attr_accessor :event_type
+
+end