mangopay-v4 4.0.0

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

@@ -0,0 +1,13 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Transfer entity
+  # A Transfer is a request to relocate e-money
+  # from one wallet to another
+  class Transfer < Transaction
+    include MangoPay::Jsonifier
+
+    # API docs specify identical fields in Transfer and Transaction.
+  end
+end

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

@@ -0,0 +1,32 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # UBO Declaration entity
+  # A UBO Declaration is an electronic version of the previous KYC document
+  # of +KycDocumentType::SHAREHOLDER_DECLARATION+, used to declare all the
+  # Ultimate Beneficial Owners of a legal user of +LegalPersonType::BUSINESS+
+  # (i.e. the shareholders of at least 25% ownership)
+  class UboDeclaration < EntityBase
+    include MangoPay::Jsonifier
+
+    # [String] ID of its owner
+    attr_accessor :user_id
+
+    # [UboDeclarationStatus] Its status
+    attr_accessor :status
+
+    # [Array] Array of +UboDeclarationRefusedReasonType+s (reasons why
+    # the UBO declaration was refused)
+    attr_accessor :refused_reason_types
+
+    # [String] Explanation of why the UBO declaration was refused
+    attr_accessor :refused_reason_message
+
+    # [Array] When sending to the API, will be a list of the IDs of the users
+    # being declared as UBOs. When retrieving +UboDeclaration+s from the API,
+    # will be a list of +DeclaredUboStatus+ objects, representing validation
+    # status for each person declared as UBO.
+    attr_accessor :declared_ubos
+  end
+end

data/lib/mangopay/model/entity/user/legal_user.rb

@@ -0,0 +1,53 @@
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # User entity of +PersonType::LEGAL+
+  # A Legal User represents a business or an organization.
+  class LegalUser < User
+    include MangoPay::Jsonifier
+
+    # [String] Their name
+    attr_accessor :name
+
+    # [LegalPersonType] Type of legal user
+    attr_accessor :legal_person_type
+
+    # [Address] Their headquarters' address
+    attr_accessor :headquarters_address
+
+    # [String] Their legal representative's first name
+    attr_accessor :legal_representative_first_name
+
+    # [String] Their legal representative's last name
+    attr_accessor :legal_representative_last_name
+
+    # [Address] Their legal representative's physical address
+    attr_accessor :legal_representative_address
+
+    # [String] Their legal representative's email address
+    attr_accessor :legal_representative_email
+
+    # [Integer] Their legal representative's birthday (UNIX timestamp)
+    attr_accessor :legal_representative_birthday
+
+    # [CountryIso] Their legal representative's nationality
+    attr_accessor :legal_representative_nationality
+
+    # [CountryIso] Their legal representative's country of residence
+    attr_accessor :legal_representative_country_of_residence
+
+    # [String] Their statute
+    attr_accessor :statute
+
+    # [String] Their proof of registration
+    attr_accessor :proof_of_registration
+
+    # [String] Their shareholder declaration
+    attr_accessor :shareholder_declaration
+
+    def initialize
+      self.person_type = PersonType::LEGAL
+    end
+  end
+end

data/lib/mangopay/model/entity/user/natural_user.rb

@@ -0,0 +1,50 @@
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # User entity of +PersonType::NATURAL+
+  # A Natural User represents an actual person.
+  class NaturalUser < User
+    include MangoPay::Jsonifier
+
+    # [String] Their first name
+    attr_accessor :first_name
+
+    # [String] Their last name
+    attr_accessor :last_name
+
+    # [Address] Their address
+    attr_accessor :address
+
+    # [Integer] Their date of birth (UNIX timestamp)
+    attr_accessor :birthday
+
+    # [String] Their place of birth
+    attr_accessor :birthplace
+
+    # [CountryIso] Their nationality
+    attr_accessor :nationality
+
+    # [CountryIso] Their current country of residence
+    attr_accessor :country_of_residence
+
+    # [String] Their occupation
+    attr_accessor :occupation
+
+    # [Integer] Their income range (see MangoModel::IncomeRange)
+    attr_accessor :income_range
+
+    # [String] Proof of their identity
+    attr_accessor :proof_of_identity
+
+    # [String] Proof of their address
+    attr_accessor :proof_of_address
+
+    # [String] Their capacity within MangoPay
+    attr_accessor :capacity
+
+    def initialize
+      self.person_type = PersonType::NATURAL
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative '../../../util/non_instantiable'
+
+module MangoModel
+
+  # User entity's base class. Should not be instantiated.
+  class User < EntityBase
+    extend NonInstantiable
+
+    # Type of user, one of +PersonType+
+    attr_accessor :person_type
+
+    # Their KYC level, one of +KycLevel+
+    attr_accessor :kyc_level
+
+    # Their email address
+    attr_accessor :email
+  end
+end

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

@@ -0,0 +1,28 @@
+require_relative '../../common/jsonifier'
+
+module MangoModel
+
+  # Wallet entity
+  # A Wallet is an object in which PayIns and Transfers from
+  # users are stored in order to collect money. Wallets can
+  # be paid into, funds can be withdrawn from them or transferred
+  # from one Wallet to another.
+  class Wallet < EntityBase
+    include MangoPay::Jsonifier
+
+    # [Array] Its owners (currently only one may be specified)
+    attr_accessor :owners
+
+    # [Money] Its current balance
+    attr_accessor :balance
+
+    # [FundsType] Its funds' type
+    attr_accessor :funds_type
+
+    # [String] Its description
+    attr_accessor :description
+
+    # [CurrencyIso] Its funds' currency
+    attr_accessor :currency
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative '../../util/enum'
+
+module MangoModel
+
+  # Bank account types enumeration
+  class AccountType
+    extend Enum
+
+    # IBAN bank account
+    IBAN = value 'IBAN'
+
+    # US format bank account
+    US = value 'US'
+
+    # CA format bank account
+    CA = value 'CA'
+
+    # GB format bank account
+    GB = value 'GB'
+
+    # Unspecified bank account format
+    OTHER = value 'OTHER'
+  end
+end

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

@@ -0,0 +1,15 @@
+require_relative '../../util/enum'
+
+module MangoModel
+
+  # Card registration status enumeration
+  class CardStatus
+    extend Enum
+
+    CREATED = value 'CREATED'
+
+    VALIDATED = value 'VALIDATED'
+
+    ERROR = value 'ERROR'
+  end
+end

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

@@ -0,0 +1,33 @@
+require_relative '../../util/enum'
+
+module MangoModel
+
+  # Card types enumeration
+  class CardType
+    extend Enum
+
+    # Visa MasterCard
+    CB_VISA_MASTERCARD = value 'CB_VISA_MASTERCARD'
+
+    # Diners card
+    DINERS = value 'DINERS'
+
+    # MasterPass card
+    MASTERPASS = value 'MASTERPAS'
+
+    # Maestro card
+    MAESTRO = value 'MAESTRO'
+
+    # P24 card
+    P24 = value 'P24'
+
+    # Ideal card
+    IDEAL = value 'IDEAL'
+
+    # BCMC card
+    BCMC = value 'BCMC'
+
+    # PayLib card
+    PAYLIB = value 'PAYLIB'
+  end
+end

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

@@ -0,0 +1,19 @@
+require_relative '../../util/enum'
+
+module MangoModel
+
+  # Card validity status enumeration
+  class CardValidity
+    extend Enum
+
+    # Before any payment processing is attempted, a card's
+    # validity is not determined
+    UNKNOWN = value 'UNKNOWN'
+
+    # Card is valid
+    VALID = value 'VALID'
+
+    # Card is not valid
+    INVALID = value 'INVALID'
+  end
+end

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

@@ -0,0 +1,759 @@
+require_relative '../../util/enum'
+
+module MangoModel
+
+  # ISO 3166-1 alpha-2 format country codes enumeration
+  class CountryIso
+    extend Enum
+
+    # Andorra
+    AD = value 'AD'
+
+    # United Arab Emirates
+    AE = value 'AE'
+
+    # Afghanistan
+    AF = value 'AF'
+
+    # Antigua and Barbuda
+    AG = value 'AG'
+
+    # Anguilla
+    AI = value 'AI'
+
+    # Albania
+    AL = value 'AL'
+
+    # Armenia
+    AM = value 'AM'
+
+    # Netherlands Antilles
+    AN = value 'AN'
+
+    # Angola
+    AO = value 'AO'
+
+    # Antarctica
+    AQ = value 'AQ'
+
+    # Argentina
+    AR = value 'AR'
+
+    # American Samoa
+    AS = value 'AS'
+
+    # Austria
+    AT = value 'AT'
+
+    # Australia
+    AU = value 'AU'
+
+    # Aruba
+    AW = value 'AW'
+
+    # Aland Islands
+    AX = value 'AX'
+
+    # Azerbaijan
+    AZ = value 'AZ'
+
+    # Bosnia and Herzegovina
+    BA = value 'BA'
+
+    # Barbados
+    BB = value 'BB'
+
+    # Bangladesh
+    BD = value 'BD'
+
+    # Belgium
+    BE = value 'BE'
+
+    # Burkina Faso
+    BF = value 'BF'
+
+    # Bulgaria
+    BG = value 'BG'
+
+    # Bahrain
+    BH = value 'BH'
+
+    # Burundi
+    BI = value 'BI'
+
+    # Benin
+    BJ = value 'BJ'
+
+    # Saint Barthélemy
+    BL = value 'BL'
+
+    # Bermuda
+    BM = value 'BM'
+
+    # Brunei Darussalam
+    BN = value 'BN'
+
+    # Bolivia, Plurinational State of
+    BO = value 'BO'
+
+    # Bonaire, Sint Eustatius and Saba
+    BQ = value 'BQ'
+
+    # Brazil
+    BR = value 'BR'
+
+    # Bahamas
+    BS = value 'BS'
+
+    # Bhutan
+    BT = value 'BT'
+
+    # Bouvet Island
+    BV = value 'BV'
+
+    # Botswana
+    BW = value 'BW'
+
+    # Belarus
+    BY = value 'BY'
+
+    # Belize
+    BZ = value 'BZ'
+
+    # Canada
+    CA = value 'CA'
+
+    # Cocos  Keeling Islands
+    CC = value 'CC'
+
+    # Congo, Democratic Republic of
+    CD = value 'CD'
+
+    # Central African Republic
+    CF = value 'CF'
+
+    # Congo
+    CG = value 'CG'
+
+    # Switzerland
+    CH = value 'CH'
+
+    # Côte d'Ivoire
+    CI = value 'CI'
+
+    # Cook Islands
+    CK = value 'CK'
+
+    # Chile
+    CL = value 'CL'
+
+    # Cameroon
+    CM = value 'CM'
+
+    # China
+    CN = value 'CN'
+
+    # Colombia
+    CO = value 'CO'
+
+    # Costa Rica
+    CR = value 'CR'
+
+    # Cuba
+    CU = value 'CU'
+
+    # Cabo Verde
+    CV = value 'CV'
+
+    # Curaçao
+    CW = value 'CW'
+
+    # Christmas Island
+    CX = value 'CX'
+
+    # Cyprus
+    CY = value 'CY'
+
+    # Czech Republic
+    CZ = value 'CZ'
+
+    # Germany
+    DE = value 'DE'
+
+    # Djibouti
+    DJ = value 'DJ'
+
+    # Denmark
+    DK = value 'DK'
+
+    # Dominica
+    DM = value 'DM'
+
+    # Dominican Republic
+    DO = value 'DO'
+
+    # Algeria
+    DZ = value 'DZ'
+
+    # Ecuador
+    EC = value 'EC'
+
+    # Estonia
+    EE = value 'EE'
+
+    # Egypt
+    EG = value 'EG'
+
+    # Western Sahara
+    EH = value 'EH'
+
+    # Eritrea
+    ER = value 'ER'
+
+    # Spain
+    ES = value 'ES'
+
+    # Ethiopia
+    ET = value 'ET'
+
+    # Finland
+    FI = value 'FI'
+
+    # Fiji
+    FJ = value 'FJ'
+
+    # Falkland Islands  Malvinas
+    FK = value 'FK'
+
+    # Micronesia, Federated States of
+    FM = value 'FM'
+
+    # Faroe Islands
+    FO = value 'FO'
+
+    # France
+    FR = value 'FR'
+
+    # Gabon
+    GA = value 'GA'
+
+    # United Kingdom
+    GB = value 'GB'
+
+    # Grenada
+    GD = value 'GD'
+
+    # Georgia
+    GE = value 'GE'
+
+    # French Guiana
+    GF = value 'GF'
+
+    # Guernsey
+    GG = value 'GG'
+
+    # Ghana
+    GH = value 'GH'
+
+    # Gibraltar
+    GI = value 'GI'
+
+    # Greenland
+    GL = value 'GL'
+
+    # Gambia
+    GM = value 'GM'
+
+    # Guinea
+    GN = value 'GN'
+
+    # Guadeloupe
+    GP = value 'GP'
+
+    # Equatorial Guinea
+    GQ = value 'GQ'
+
+    # Greece
+    GR = value 'GR'
+
+    # South Georgia and the South Sandwich Islands
+    GS = value 'GS'
+
+    # Guatemala
+    GT = value 'GT'
+
+    # Guam
+    GU = value 'GU'
+
+    # Guinea-Bissau
+    GW = value 'GW'
+
+    # Guyana
+    GY = value 'GY'
+
+    # Hong Kong
+    HK = value 'HK'
+
+    # Heard Island and McDonald Islands
+    HM = value 'HM'
+
+    # Honduras
+    HN = value 'HN'
+
+    # Croatia
+    HR = value 'HR'
+
+    # Haiti
+    HT = value 'HT'
+
+    # Hungary
+    HU = value 'HU'
+
+    # Indonesia
+    ID = value 'ID'
+
+    # Ireland
+    IE = value 'IE'
+
+    # Israel
+    IL = value 'IL'
+
+    # Isle of Man
+    IM = value 'IM'
+
+    # India
+    IN = value 'IN'
+
+    # British Indian Ocean Territory
+    IO = value 'IO'
+
+    # Iraq
+    IQ = value 'IQ'
+
+    # Iran, Islamic Republic of
+    IR = value 'IR'
+
+    # Iceland
+    IS = value 'IS'
+
+    # Italy
+    IT = value 'IT'
+
+    # Jersey
+    JE = value 'JE'
+
+    # Jamaica
+    JM = value 'JM'
+
+    # Jordan
+    JO = value 'JO'
+
+    # Japan
+    JP = value 'JP'
+
+    # Kenya
+    KE = value 'KE'
+
+    # Kyrgyzstan
+    KG = value 'KG'
+
+    # Cambodia
+    KH = value 'KH'
+
+    # Kiribati
+    KI = value 'KI'
+
+    # Comoros
+    KM = value 'KM'
+
+    # Saint Kitts and Nevis
+    KN = value 'KN'
+
+    # Korea, Democratic People's Republic of
+    KP = value 'KP'
+
+    # Korea, Republic of
+    KR = value 'KR'
+
+    # Kuwait
+    KW = value 'KW'
+
+    # Cayman Islands
+    KY = value 'KY'
+
+    # Kazakhstan
+    KZ = value 'KZ'
+
+    # Lao People's Democratic Republic
+    LA = value 'LA'
+
+    # Lebanon
+    LB = value 'LB'
+
+    # Saint Lucia
+    LC = value 'LC'
+
+    # Liechtenstein
+    LI = value 'LI'
+
+    # Sri Lanka
+    LK = value 'LK'
+
+    # Liberia
+    LR = value 'LR'
+
+    # Lesotho
+    LS = value 'LS'
+
+    # Lithuania
+    LT = value 'LT'
+
+    # Luxembourg
+    LU = value 'LU'
+
+    # Latvia
+    LV = value 'LV'
+
+    # Libya
+    LY = value 'LY'
+
+    # Morocco
+    MA = value 'MA'
+
+    # Monaco
+    MC = value 'MC'
+
+    # Moldova, Republic of
+    MD = value 'MD'
+
+    # Montenegro
+    ME = value 'ME'
+
+    # Saint Martin  French part
+    MF = value 'MF'
+
+    # Madagascar
+    MG = value 'MG'
+
+    # Marshall Islands
+    MH = value 'MH'
+
+    # Macedonia, the former Yugoslav Republic of
+    MK = value 'MK'
+
+    # Mali
+    ML = value 'ML'
+
+    # Myanmar
+    MM = value 'MM'
+
+    # Mongolia
+    MN = value 'MN'
+
+    # Macao
+    MO = value 'MO'
+
+    # Northern Marina Islands
+    MP = value 'MP'
+
+    # Martinique
+    MQ = value 'MQ'
+
+    # Mauritania
+    MR = value 'MR'
+
+    # Montserrat
+    MS = value 'MS'
+
+    # Malta
+    MT = value 'MT'
+
+    # Mauritius
+    MU = value 'MU'
+
+    # Maldives
+    MV = value 'MV'
+
+    # Malawi
+    MW = value 'MW'
+
+    # Mexico
+    MX = value 'MX'
+
+    # Malaysia
+    MY = value 'MY'
+
+    # Mozambique
+    MZ = value 'MZ'
+
+    # Namibia
+    NA = value 'NA'
+
+    # New Caledonia
+    NC = value 'NC'
+
+    # Niger
+    NE = value 'NE'
+
+    # Norfolk Island
+    NF = value 'NF'
+
+    # Nigeria
+    NG = value 'NG'
+
+    # Nicaragua
+    NI = value 'NI'
+
+    # Netherlands
+    NL = value 'NL'
+
+    # Norway
+    NO = value 'NO'
+
+    # Nepal
+    NP = value 'NP'
+
+    # Nauru
+    NR = value 'NR'
+
+    # Niue
+    NU = value 'NU'
+
+    # New Zealand
+    NZ = value 'NZ'
+
+    # Oman
+    OM = value 'OM'
+
+    # Panama
+    PA = value 'PA'
+
+    # Peru
+    PE = value 'PE'
+
+    # French Polynesia
+    PF = value 'PF'
+
+    # Papua New Guinea
+    PG = value 'PG'
+
+    # Philippines
+    PH = value 'PH'
+
+    # Pakistan
+    PK = value 'PK'
+
+    # Poland
+    PL = value 'PL'
+
+    # Saint Pierre and Miquelon
+    PM = value 'PM'
+
+    # Pitcairn
+    PN = value 'PN'
+
+    # Puerto Rico
+    PR = value 'PR'
+
+    # Palestine, State of
+    PS = value 'PS'
+
+    # Portugal
+    PT = value 'PT'
+
+    # Palau
+    PW = value 'PW'
+
+    # Paraguay
+    PY = value 'PY'
+
+    # Qatar
+    QA = value 'QA'
+
+    # Réunion
+    RE = value 'RE'
+
+    # Romania
+    RO = value 'RO'
+
+    # Serbia
+    RS = value 'RS'
+
+    # Russian Federation
+    RU = value 'RU'
+
+    # Rwanda
+    RW = value 'RW'
+
+    # Saudi Arabia
+    SA = value 'SA'
+
+    # Solomon Islands
+    SB = value 'SB'
+
+    # Seychelles
+    SC = value 'SC'
+
+    # Sudan
+    SD = value 'SD'
+
+    # Sweden
+    SE = value 'SE'
+
+    # Singapore
+    SG = value 'SG'
+
+    # Saint Helena, Ascension and Tristan da Cunha
+    SH = value 'SH'
+
+    # Slovenia
+    SI = value 'SI'
+
+    # Svalbard and Jan Mayen
+    SJ = value 'SJ'
+
+    # Slovakia
+    SK = value 'SK'
+
+    # Sierra Leone
+    SL = value 'SL'
+
+    # San Marino
+    SM = value 'SM'
+
+    # Senegal
+    SN = value 'SN'
+
+    # Somalia
+    SO = value 'SO'
+
+    # Suriname
+    SR = value 'SR'
+
+    # South Sudan
+    SS = value 'SS'
+
+    # Sao Tome and Principe
+    ST = value 'ST'
+
+    # El Salvador
+    SV = value 'SV'
+
+    # Sint Maarten  Dutch part
+    SX = value 'SX'
+
+    # Syrian Arab Republic
+    SY = value 'SY'
+
+    # Swaziland
+    SZ = value 'SZ'
+
+    # Turks and Caicos Islands
+    TC = value 'TC'
+
+    # Chad
+    TD = value 'TD'
+
+    # French Southern Territories
+    TF = value 'TF'
+
+    # Togo
+    TG = value 'TG'
+
+    # Thailand
+    TH = value 'TH'
+
+    # Tajikistan
+    TJ = value 'TJ'
+
+    # Tokelau
+    TK = value 'TK'
+
+    # Timor-Leste
+    TL = value 'TL'
+
+    # Turkmenistan
+    TM = value 'TM'
+
+    # Tunisia
+    TN = value 'TN'
+
+    # Tonga
+    TO = value 'TO'
+
+    # Turkey
+    TR = value 'TR'
+
+    # Trinidad and Tobago
+    TT = value 'TT'
+
+    # Tuvalu
+    TV = value 'TV'
+
+    # Taiwan, Province of China
+    TW = value 'TW'
+
+    # Tanzania, United Republic of
+    TZ = value 'TZ'
+
+    # Ukraine
+    UA = value 'UA'
+
+    # Uganda
+    UG = value 'UG'
+
+    # United States Minor Outlying Islands
+    UM = value 'UM'
+
+    # United States
+    US = value 'US'
+
+    # Uruguay
+    UY = value 'UY'
+
+    # Uzbekistan
+    UZ = value 'UZ'
+
+    # Holy See  Vatican City State
+    VA = value 'VA'
+
+    # Saint Vincent and the Grenadines
+    VC = value 'VC'
+
+    # Venezuela, Bolivarian Republic of
+    VE = value 'VE'
+
+    # Virgin Islands, British
+    VG = value 'VG'
+
+    # Virgin Islands, U.S.
+    VI = value 'VI'
+
+    # Vietnam
+    VN = value 'VN'
+
+    # Vanuatu
+    VU = value 'VU'
+
+    # Wallis and Futuna
+    WF = value 'WF'
+
+    # Samoa
+    WS = value 'WS'
+
+    # Yemen
+    YE = value 'YE'
+
+    # Mayotte
+    YT = value 'YT'
+
+    # South Africa
+    ZA = value 'ZA'
+
+    # Zambia
+    ZM = value 'ZM'
+
+    # Zimbabwe
+    ZW = value 'ZW'
+  end
+end