mangopay-v4 4.0.0 → 4.0.1

data/lib/mangopay/model/enum/secure_mode.rb

@@ -1,16 +1,16 @@
-require_relative '../../util/enum'
-
-module MangoModel
-
-  # Secure modes enumeration
-  class SecureMode
-    extend Enum
-
-    # Automatic activation of the Secure Mode, when transaction
-    # is higher than 50 EUR or when MangoPay detects there is a higher risk
-    DEFAULT = value 'DEFAULT'
-
-    # Force activation of the Secure Mode for a transaction
-    FORCE = value 'FORCE'
-  end
+require_relative '../../util/enum'
+
+module MangoModel
+
+  # Secure modes enumeration
+  class SecureMode
+    extend Enum
+
+    # Automatic activation of the Secure Mode, when transaction
+    # is higher than 50 EUR or when MangoPay detects there is a higher risk
+    DEFAULT = value 'DEFAULT'
+
+    # Force activation of the Secure Mode for a transaction
+    FORCE = value 'FORCE'
+  end
 end

data/lib/mangopay/model/enum/transaction_nature.rb

@@ -1,17 +1,17 @@
-require_relative '../../util/enum'
-
-module MangoModel
-
-  # Transaction nature enumeration
-  class TransactionNature
-    extend Enum
-
-    REGULAR = value 'REGULAR'
-
-    REPUDIATION = value 'REPUDIATION'
-
-    REFUND = value 'REFUND'
-
-    SETTLEMENT = value 'SETTLEMENT'
-  end
+require_relative '../../util/enum'
+
+module MangoModel
+
+  # Transaction nature enumeration
+  class TransactionNature
+    extend Enum
+
+    REGULAR = value 'REGULAR'
+
+    REPUDIATION = value 'REPUDIATION'
+
+    REFUND = value 'REFUND'
+
+    SETTLEMENT = value 'SETTLEMENT'
+  end
 end

data/lib/mangopay/model/enum/transaction_status.rb

@@ -1,15 +1,15 @@
-require_relative '../../util/enum'
-
-module MangoModel
-
-  # Transaction status enumeration
-  class TransactionStatus
-    extend Enum
-
-    CREATED = value 'CREATED'
-
-    SUCCEEDED = value 'SUCCEEDED'
-
-    FAILED = value 'FAILED'
-  end
+require_relative '../../util/enum'
+
+module MangoModel
+
+  # Transaction status enumeration
+  class TransactionStatus
+    extend Enum
+
+    CREATED = value 'CREATED'
+
+    SUCCEEDED = value 'SUCCEEDED'
+
+    FAILED = value 'FAILED'
+  end
 end

data/lib/mangopay/model/enum/transaction_type.rb

@@ -1,15 +1,15 @@
-require_relative '../../util/enum'
-
-module MangoModel
-
-  # Transaction types enumeration
-  class TransactionType
-    extend Enum
-
-    PAYIN = value 'PAYIN'
-
-    PAYOUT = value 'PAYOUT'
-
-    TRANSFER = value 'TRANSFER'
-  end
+require_relative '../../util/enum'
+
+module MangoModel
+
+  # Transaction types enumeration
+  class TransactionType
+    extend Enum
+
+    PAYIN = value 'PAYIN'
+
+    PAYOUT = value 'PAYOUT'
+
+    TRANSFER = value 'TRANSFER'
+  end
 end

data/lib/mangopay/model/enum/ubo_declaration_refused_reason_type.rb

@@ -1,19 +1,19 @@
-require_relative '../../util/enum'
-
-module MangoModel
-
-  # UBO Declaration refusal reasons enumeration
-  class UboDeclarationRefusedReasonType
-    extend Enum
-
-    # At least one natural user is missing from the declaration
-    MISSING_UBO = value 'MISSING_UBO'
-
-    # At least one of the natural users should not be declared as UBO
-    INVALID_DECLARED_UBO = value 'INVALID_DECLARED_UBO'
-
-    # At least one of the natural users declared as UBOs has been
-    # created with wrong details (i.e. date of birth, country of residence)
-    INVALID_UBO_DETAILS = value 'INVALID_UBO_DETAILS'
-  end
+require_relative '../../util/enum'
+
+module MangoModel
+
+  # UBO Declaration refusal reasons enumeration
+  class UboDeclarationRefusedReasonType
+    extend Enum
+
+    # At least one natural user is missing from the declaration
+    MISSING_UBO = value 'MISSING_UBO'
+
+    # At least one of the natural users should not be declared as UBO
+    INVALID_DECLARED_UBO = value 'INVALID_DECLARED_UBO'
+
+    # At least one of the natural users declared as UBOs has been
+    # created with wrong details (i.e. date of birth, country of residence)
+    INVALID_UBO_DETAILS = value 'INVALID_UBO_DETAILS'
+  end
 end

data/lib/mangopay/model/enum/ubo_declaration_status.rb

@@ -1,21 +1,21 @@
-require_relative '../../util/enum'
-
-module MangoModel
-
-  # UBO Declaration status enumeration
-  class UboDeclarationStatus
-    extend Enum
-
-    # UBO declaration has been created
-    CREATED = value 'CREATED'
-
-    # UBO declaration has been submitted for validation
-    VALIDATION_ASKED = value 'VALIDATION_ASKED'
-
-    # UBO declaration has been validated
-    VALIDATED = value 'VALIDATED'
-
-    # UBO declaration has been refused
-    REFUSED = value 'REFUSED'
-  end
+require_relative '../../util/enum'
+
+module MangoModel
+
+  # UBO Declaration status enumeration
+  class UboDeclarationStatus
+    extend Enum
+
+    # UBO declaration has been created
+    CREATED = value 'CREATED'
+
+    # UBO declaration has been submitted for validation
+    VALIDATION_ASKED = value 'VALIDATION_ASKED'
+
+    # UBO declaration has been validated
+    VALIDATED = value 'VALIDATED'
+
+    # UBO declaration has been refused
+    REFUSED = value 'REFUSED'
+  end
 end

data/lib/mangopay/model/event.rb

@@ -1,18 +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
+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

@@ -1,194 +1,215 @@
-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
+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 'enum/business_type'
+require_relative 'enum/sector'
+require_relative 'enum/avs_result'
+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'
+require_relative 'platform_categorization'
+require_relative 'billing'
+require_relative 'security_info'
+
+# 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],
+    Sector => %w[sector],
+    BusinessType => %w[business_type],
+    PlatformCategorization => %w[platform_categorization],
+    Billing => %w[billing],
+    SecurityInfo => %w[security_info],
+    AvsResult => %w[avs_result]
+  }
+
+  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::BANK_WIRE.to_s\
+         && hash['ExecutionType'] == PayInExecutionType::EXTERNAL_INSTRUCTION.to_s
+        BankWireExternalInstructionPayIn
+      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
+      elsif hash['PaymentType'] == PayInPaymentType::PAYPAL.to_s\
+         && hash['ExecutionType'] == PayInExecutionType::WEB.to_s
+        PaypalWebPayIn
+      elsif hash['PaymentType'] == PayInPaymentType::APPLEPAY.to_s\
+         && hash['ExecutionType'] == PayInExecutionType::DIRECT.to_s
+        ApplePayPayIn
+      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