mangopay-v4 4.0.0

data/lib/mangopay/model/entity/account/gb_bank_account.rb

@@ -0,0 +1,21 @@
+require_relative 'bank_account'
+require_relative '../../enum/account_type'
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # Bank account of +AccountType::GB+
+  class GbBankAccount < BankAccount
+    include MangoPay::Jsonifier
+
+    # [String] Its sort code (6 digits)
+    attr_accessor :sort_code
+
+    # [String] Its account number (8 digits)
+    attr_accessor :account_number
+
+    def initialize
+      self.type = MangoModel::AccountType::GB
+    end
+  end
+end

data/lib/mangopay/model/entity/account/iban_bank_account.rb

@@ -0,0 +1,21 @@
+require_relative 'bank_account'
+require_relative '../../enum/account_type'
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # Bank account of +AccountType::IBAN+
+  class IbanBankAccount < BankAccount
+    include MangoPay::Jsonifier
+
+    # [String] Its IBAN code
+    attr_accessor :iban
+
+    # [String] Its BIC code
+    attr_accessor :bic
+
+    def initialize
+      self.type = MangoModel::AccountType::IBAN
+    end
+  end
+end

data/lib/mangopay/model/entity/account/other_bank_account.rb

@@ -0,0 +1,24 @@
+require_relative 'bank_account'
+require_relative '../../enum/account_type'
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # Bank account of +AccountType::OTHER+
+  class OtherBankAccount < BankAccount
+    include MangoPay::Jsonifier
+
+    # [String] Its BIC code
+    attr_accessor :bic
+
+    # [String] Its account number
+    attr_accessor :account_number
+
+    # [CountryIso] Its country
+    attr_accessor :country
+
+    def initialize
+      self.type = MangoModel::AccountType::OTHER
+    end
+  end
+end

data/lib/mangopay/model/entity/account/us_bank_account.rb

@@ -0,0 +1,24 @@
+require_relative 'bank_account'
+require_relative '../../enum/account_type'
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # Bank account of +AccountType::US+
+  class UsBankAccount < BankAccount
+    include MangoPay::Jsonifier
+
+    # [String] Its account number (digits only)
+    attr_accessor :account_number
+
+    # [String] Its ABA (9 digits )
+    attr_accessor :aba
+
+    # [DepositType] Its deposit type
+    attr_accessor :deposit_account_type
+
+    def initialize
+      self.type = MangoModel::AccountType::US
+    end
+  end
+end

data/lib/mangopay/model/entity/card.rb

@@ -0,0 +1,45 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Card entity
+  class Card < EntityBase
+    include MangoPay::Jsonifier
+
+    # [Integer] Its expiry date (MM/YY format)
+    attr_accessor :expiration_date
+
+    # [String] A partially obfuscated version of its credit card number
+    attr_accessor :alias
+
+    # [String] Its provider
+    attr_accessor :card_provider
+
+    # [CardType] Its type
+    attr_accessor :card_type
+
+    # [String] Country of its address
+    attr_accessor :country
+
+    # [String] Its product type
+    attr_accessor :product
+
+    # [String] Its bank code
+    attr_accessor :bank_code
+
+    # [true/false] Whether or not it is active
+    attr_accessor :active
+
+    # [CurrencyIso] Its currency
+    attr_accessor :currency
+
+    # [CardValidity] Whether or not it is valid
+    attr_accessor :validity
+
+    # [String] A unique representation of a 16-digit card number
+    attr_accessor :fingerprint
+
+    # [String] ID of its owner
+    attr_accessor :user_id
+  end
+end

data/lib/mangopay/model/entity/card_registration.rb

@@ -0,0 +1,43 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Card Registration entity
+  class CardRegistration < EntityBase
+    include MangoPay::Jsonifier
+
+    # [String] Its owner's ID
+    attr_accessor :user_id
+
+    # [CurrencyIso] Its currency
+    attr_accessor :currency
+
+    # [String] Its access key (a special key needed for registering a card)
+    attr_accessor :access_key
+
+    # [String] A specific value to pass to the card registration URL
+    attr_accessor :preregistration_data
+
+    # [String] The URL to submit the card details form to
+    attr_accessor :card_registration_url
+
+    # [String] Having registered a card, this confirmation hash needs to be
+    # updated to the card item
+    attr_accessor :registration_data
+
+    # [CardType] The type of card
+    attr_accessor :card_type
+
+    # [String] The card's ID
+    attr_accessor :card_id
+
+    # [String] The result code
+    attr_accessor :result_code
+
+    # [String] Explanation of the result
+    attr_accessor :result_message
+
+    # [CardStatus] Status of the registration
+    attr_accessor :status
+  end
+end

data/lib/mangopay/model/entity/client.rb

@@ -0,0 +1,63 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Client entity
+  # The Client object allows viewing and editing of various
+  # details concerning the implementing platform.
+  class Client
+    include MangoPay::Jsonifier
+
+    # [String] Its pretty name
+    attr_accessor :name
+
+    # [String] Its registered company name
+    attr_accessor :registered_name
+
+    # [String] Its ID
+    attr_accessor :client_id
+
+    # [String] Its primary branding colour (Hex code)
+    attr_accessor :primary_theme_colour
+
+    # [String] Its primary branding colour for buttons (Hex code)
+    attr_accessor :primary_button_colour
+
+    # [String] URL of its logo
+    attr_accessor :logo
+
+    # [Array] List of email addresses for contacting its technical
+    # support team
+    attr_accessor :tech_emails
+
+    # [Array] List of email addresses for contacting its
+    # administration/commercial team
+    attr_accessor :admin_emails
+
+    # [Array] List of email addresses for contacting its
+    # fraud prevention/compliance team
+    attr_accessor :fraud_emails
+
+    # [Array] List of email addresses for contacting its billing team
+    attr_accessor :billing_emails
+
+    # [String] Description of what its implementing platform does
+    attr_accessor :platform_description
+
+    # [PlatformType] Its implementing platform type
+    attr_accessor :platform_type
+
+    # [String] Its implementing platform's website URL
+    attr_accessor :platform_url
+
+    # [Address] Its company's headquarters' address
+    attr_accessor :headquarters_address
+
+    # [String] Its company's tax (or VAT) number
+    attr_accessor :tax_number
+
+    # [String] Its company's unique MangoPay reference to be used when
+    # contacting the MangoPay team
+    attr_accessor :company_reference
+  end
+end

data/lib/mangopay/model/entity/client_wallet.rb

@@ -0,0 +1,23 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Client Wallet entity
+  # The Client Wallet is very similar to a normal Wallet except the parameters
+  # +description+ and +owners+ are removed. Currently, there are two types of
+  # Client Wallet (specified by the +funds_type+ parameter) - +FEES+ where your
+  # collected turnover is stored and +CREDIT_ where repudiations are taken from.
+  # A normal wallet for a user has the +FundsType+ of +DEFAULT+.
+  class ClientWallet < EntityBase
+    include MangoPay::Jsonifier
+
+    # [Money] Its current balance
+    attr_accessor :balance
+
+    # [FundsType] Its funds' type
+    attr_accessor :funds_type
+
+    # [CurrencyIso] Its funds' currency
+    attr_accessor :currency
+  end
+end

data/lib/mangopay/model/entity/dispute.rb

@@ -0,0 +1,50 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Dispute entity
+  # The Dispute object is used when a user requests a chargeback
+  # of a transaction to their bank. In turn, their bank withdraws
+  # the funds from MangoPay, and MangoPay will then repudiate
+  # the required funds from your client credit wallet.
+  class Dispute < EntityBase
+    include MangoPay::Jsonifier
+
+    # [DisputeType] Its type
+    attr_accessor :dispute_type
+
+    # [String] The initial transaction's ID
+    attr_accessor :initial_transaction_id
+
+    # [TransactionType] The initial transaction's type
+    attr_accessor :initial_transaction_type
+
+    # [String] Its result code
+    attr_accessor :result_code
+
+    # {String] Explanation of its result
+    attr_accessor :result_message
+
+    # [DisputeReason] Its reason
+    attr_accessor :dispute_reason
+
+    # [DisputeStatus] Its status
+    attr_accessor :status
+
+    # [String] Explanation of the status
+    attr_accessor :status_message
+
+    # [Money] The funds that were disputed
+    attr_accessor :disputed_funds
+
+    # [Money] The funds wished to be contested
+    attr_accessor :contested_funds
+
+    # [Integer] The deadline by which the dispute must be contested,
+    # if necessary (UNIX timestamp)
+    attr_accessor :contest_deadline_date
+
+    # [String] ID of the associated repudiation transaction
+    attr_accessor :repudiation_id
+  end
+end

data/lib/mangopay/model/entity/dispute_document.rb

@@ -0,0 +1,29 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Dispute Document entity
+  # A Dispute Document must be created in order to upload pages
+  # of a document pertaining to a certain dispute.
+  class DisputeDocument < EntityBase
+    include MangoPay::Jsonifier
+
+    # [String] ID of the corresponding dispute
+    attr_accessor :dispute_id
+
+    # [DocumentStatus] Its status
+    attr_accessor :status
+
+    # [DisputeDocumentType] Its type
+    attr_accessor :type
+
+    # [DisputeDocRefusedReasonType] Type of its refusal reason
+    attr_accessor :refused_reason_type
+
+    # [String] Explanation of its refusal
+    attr_accessor :refused_reason_message
+
+    # [Integer] Time when the document was processed (UNIX timestamp)
+    attr_accessor :processed_date
+  end
+end

data/lib/mangopay/model/entity/entity_base.rb

@@ -0,0 +1,18 @@
+require_relative '../../util/non_instantiable'
+
+module MangoModel
+
+  # Base class for entities which provides common properties
+  class EntityBase
+    extend NonInstantiable
+
+    # Unique identifier
+    attr_accessor :id
+
+    # Custom data
+    attr_accessor :tag
+
+    # Date of creation (UNIX timestamp)
+    attr_accessor :creation_date
+  end
+end

data/lib/mangopay/model/entity/hook.rb

@@ -0,0 +1,26 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Hook entity
+  # Once setup, a hook entity allows MangoPay to make a request
+  # to a specific URL on the implementing server to make it aware
+  # of various Events (i.e. a failed PayOut). One URL can be
+  # configured for each +EventType+.
+  class Hook < EntityBase
+    include MangoPay::Jsonifier
+
+    # [String] The URL that will be pinged for events of the
+    # specified type
+    attr_accessor :url
+
+    # [HookStatus] Whether or not the hook is enabled
+    attr_accessor :status
+
+    # [HookValidity] Whether or not the hook is valid
+    attr_accessor :validity
+
+    # [EventType] Type of event handled
+    attr_accessor :event_type
+  end
+end

data/lib/mangopay/model/entity/kyc_document.rb

@@ -0,0 +1,28 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # KYC Document entity
+  # The KYC Document object is a request to validate a required document.
+  class KycDocument < EntityBase
+    include MangoPay::Jsonifier
+
+    # [KycDocumentType] Its type
+    attr_accessor :type
+
+    # [String] ID of its owner
+    attr_accessor :user_id
+
+    # [DocumentStatus] Its processing status
+    attr_accessor :status
+
+    # [String] The message accompanying a refusal
+    attr_accessor :refused_reason_message
+
+    # [KycDocRefusedReasonType] Reason of refusal
+    attr_accessor :refused_reason_type
+
+    # [Integer] Time when the document was processed (UNIX timestamp)
+    attr_accessor :processed_date
+  end
+end

data/lib/mangopay/model/entity/mandate.rb

@@ -0,0 +1,51 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Mandate entity
+  class Mandate < EntityBase
+    include MangoPay::Jsonifier
+
+    # [String] ID of the concerned bank account
+    attr_accessor :bank_account_id
+
+    # [String] Its owner's ID
+    attr_accessor :user_id
+
+    # [String] URL to redirect to after payment (whether or not successful)
+    attr_accessor :return_url
+
+    # [String] URL which to redirect users to for them to proceed
+    # with the payment
+    attr_accessor :redirect_url
+
+    # [String] URL where the mandate can be downloaded
+    attr_accessor :document_url
+
+    # [MandateCultureCode] ISO code of the language to use for the mandate
+    # confirmation page
+    attr_accessor :culture
+
+    # [MandateScheme] Its type, will only be set once the mandate
+    # has been submitted
+    attr_accessor :scheme
+
+    # [MandateStatus] Its status
+    attr_accessor :status
+
+    # [String] Its result code
+    attr_accessor :result_code
+
+    # [String] Explanation of its result
+    attr_accessor :result_message
+
+    # [MandateExecutionType] Execution type for its creation
+    attr_accessor :execution_type
+
+    # [MandateType] Its type
+    attr_accessor :mandate_type
+
+    # [String] Its banking reference
+    attr_accessor :bank_reference
+  end
+end