mangopay-v4 4.0.0 → 4.0.1

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

@@ -1,146 +1,146 @@
-require_relative '../uri_provider'
-require_relative '../../model/request/filter_request'
-require_relative '../../model/request/deactivation_request'
-
-module MangoApi
-
-  # Provides API method delegates concerning the +BankAccount+ entity
-  module BankAccounts
-    class << self
-      include UriProvider
-
-      # Creates a new bank account entity.
-      #
-      # +BankAccount+ properties:
-      # * +IbanBankAccount
-      #   * +tag+ - optional
-      #   * +owner_address+ - required
-      #   * +owner_name+ - required
-      #   * +iban+ - required
-      #   * +bic+ - optional
-      # * +UsBankAccount+
-      #   * +tag+ - optional
-      #   * +owner_address+ - required
-      #   * +owner_name+ - required
-      #   * +account_number+ - required
-      #   * +aba+ - required
-      #   * +deposit_account_type+ - optional
-      # * +CaBankAccount+
-      #   * +tag+ - optional
-      #   * +owner_address+ - required
-      #   * +owner_name+ - required
-      #   * +branch_code+ - required
-      #   * +institution_number+ - required
-      #   * +account_number+ - required
-      #   * +bank_name+ - required
-      # * +GbBankAccount+
-      #   * +tag+ - optional
-      #   * +owner_address+ - required
-      #   * +owner_name+ - required
-      #   * +sort_code+ - required
-      #   * +account_number+ - required
-      # * +OtherBankAccount+
-      #   * +tag+ optional
-      #   * +owner_address+ - required
-      #   * +owner_name+ - required
-      #   * +country+ - required
-      #   * +bic+ - required
-      #   * +account_number+ - required
-      #
-      # @param +account+ [BankAccount] model object of account to be created
-      # @param +id_key+ [String] idempotency key for future response replication
-      # @return [BankAccount] the newly-created BankAccount entity object
-      def create(account, id_key = nil)
-        uri = provide_uri(:create_account, account)
-        response = HttpClient.post(uri, account, id_key)
-        parse response
-      end
-
-      # Deactivates a bank account entity.
-      #
-      # @param +user_id+ [String] ID of the owner of the account
-      # being deactivated
-      # @param +account_id+ [String] ID of the bank account being deactivated
-      # @return [BankAccount] deactivated BankAccount entity object
-      def deactivate(user_id, account_id)
-        uri = provide_uri(:deactivate_account, user_id, account_id)
-        response = HttpClient.put(uri, DeactivationRequest.new)
-        parse response
-      end
-
-      # Retrieves a bank account for a user.
-      #
-      # @param +user_id+ [String] ID of the bank account's owner
-      # @param +account+id+ [String] ID of the bank account
-      # @return [BankAccount] the corresponding BankAccount object
-      def get(user_id, account_id)
-        uri = provide_uri(:get_account, user_id, account_id)
-        response = HttpClient.get(uri)
-        parse response
-      end
-
-      # Retrieves pages of a user's bank accounts. 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
-      #
-      # @param +user_id+ [String] ID of the user whose bank accounts to get
-      # @return [Array] parsed BankAccount entity objects
-      def all(user_id)
-        uri = provide_uri(:get_accounts, user_id)
-        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
-      # BankAccount entity objects.
-      #
-      # @param +results+ [Array] JSON-originating data hashes
-      # @return [Array] parsed BankAccount entity objects
-      def parse_results(results)
-        results.collect do |entity|
-          parse entity
-        end
-      end
-
-      # Parses a JSON-originating hash into the corresponding
-      # BankAccount entity object.
-      #
-      # @param +response+ [Hash] JSON-originating data hash
-      # @return [BankAccount] corresponding BankAccount entity object
-      def parse(response)
-        type = bank_account_type(response)
-        type.new.dejsonify response
-      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 MangoModel::AccountType::IBAN.to_s
-          MangoModel::IbanBankAccount
-        when MangoModel::AccountType::US.to_s
-          MangoModel::UsBankAccount
-        when MangoModel::AccountType::CA.to_s
-          MangoModel::CaBankAccount
-        when MangoModel::AccountType::GB.to_s
-          MangoModel::GbBankAccount
-        else
-          MangoModel::OtherBankAccount
-        end
-      end
-    end
-  end
+require_relative '../uri_provider'
+require_relative '../../model/request/filter_request'
+require_relative '../../model/request/deactivation_request'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +BankAccount+ entity
+  module BankAccounts
+    class << self
+      include UriProvider
+
+      # Creates a new bank account entity.
+      #
+      # +BankAccount+ properties:
+      # * +IbanBankAccount
+      #   * +tag+ - optional
+      #   * +owner_address+ - required
+      #   * +owner_name+ - required
+      #   * +iban+ - required
+      #   * +bic+ - optional
+      # * +UsBankAccount+
+      #   * +tag+ - optional
+      #   * +owner_address+ - required
+      #   * +owner_name+ - required
+      #   * +account_number+ - required
+      #   * +aba+ - required
+      #   * +deposit_account_type+ - optional
+      # * +CaBankAccount+
+      #   * +tag+ - optional
+      #   * +owner_address+ - required
+      #   * +owner_name+ - required
+      #   * +branch_code+ - required
+      #   * +institution_number+ - required
+      #   * +account_number+ - required
+      #   * +bank_name+ - required
+      # * +GbBankAccount+
+      #   * +tag+ - optional
+      #   * +owner_address+ - required
+      #   * +owner_name+ - required
+      #   * +sort_code+ - required
+      #   * +account_number+ - required
+      # * +OtherBankAccount+
+      #   * +tag+ optional
+      #   * +owner_address+ - required
+      #   * +owner_name+ - required
+      #   * +country+ - required
+      #   * +bic+ - required
+      #   * +account_number+ - required
+      #
+      # @param +account+ [BankAccount] model object of account to be created
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [BankAccount] the newly-created BankAccount entity object
+      def create(account, id_key = nil)
+        uri = provide_uri(:create_account, account)
+        response = HttpClient.post(uri, account, id_key)
+        parse response
+      end
+
+      # Deactivates a bank account entity.
+      #
+      # @param +user_id+ [String] ID of the owner of the account
+      # being deactivated
+      # @param +account_id+ [String] ID of the bank account being deactivated
+      # @return [BankAccount] deactivated BankAccount entity object
+      def deactivate(user_id, account_id)
+        uri = provide_uri(:deactivate_account, user_id, account_id)
+        response = HttpClient.put(uri, DeactivationRequest.new)
+        parse response
+      end
+
+      # Retrieves a bank account for a user.
+      #
+      # @param +user_id+ [String] ID of the bank account's owner
+      # @param +account+id+ [String] ID of the bank account
+      # @return [BankAccount] the corresponding BankAccount object
+      def get(user_id, account_id)
+        uri = provide_uri(:get_account, user_id, account_id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      # Retrieves pages of a user's bank accounts. 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
+      #
+      # @param +user_id+ [String] ID of the user whose bank accounts to get
+      # @return [Array] parsed BankAccount entity objects
+      def all(user_id)
+        uri = provide_uri(:get_accounts, user_id)
+        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
+      # BankAccount entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] parsed BankAccount entity objects
+      def parse_results(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+
+      # Parses a JSON-originating hash into the corresponding
+      # BankAccount entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [BankAccount] corresponding BankAccount entity object
+      def parse(response)
+        type = bank_account_type(response)
+        type.new.dejsonify response
+      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 MangoModel::AccountType::IBAN.to_s
+          MangoModel::IbanBankAccount
+        when MangoModel::AccountType::US.to_s
+          MangoModel::UsBankAccount
+        when MangoModel::AccountType::CA.to_s
+          MangoModel::CaBankAccount
+        when MangoModel::AccountType::GB.to_s
+          MangoModel::GbBankAccount
+        else
+          MangoModel::OtherBankAccount
+        end
+      end
+    end
+  end
 end

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

@@ -0,0 +1,83 @@
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +BankingAlias+ entity
+  module BankingAliases
+    class << self
+      include UriProvider
+
+      # Creates an IBAN banking alias
+      #
+      # +BankingAlias+ properties:
+      # * Required:
+      #   * credited_user_id
+      #   * wallet_id
+      #   * type
+      #   * country
+      #   * owner_name
+      #   * active
+      #  @param +banking_alias+ [BankingAlias] model object of banking alias to be created
+      #  @param +wallet_id+ [String] the wallet_id
+      #  @return [BakingAliasIBAN]
+      def create_iban(banking_alias, wallet_id)
+        uri = provide_uri(:banking_alias_create_iban, wallet_id)
+        response = HttpClient.post(uri, banking_alias)
+        parse response
+      end
+
+      # Retrieves a banking alias entity.
+      #
+      # @param +id+ [String] ID of the banking alias to be retrieved
+      # @param +banking_alias+ [BankingAlias] Whether is active or not
+      # @return [BankingAlias] the requested entity object
+      def update(id, banking_alias)
+        uri = provide_uri(:banking_alias_save, id)
+        response = HttpClient.put(uri, banking_alias)
+        parse response
+      end
+
+      # Retrieves a banking alias entity.
+      #
+      # @param +id+ [String] ID of the banking alias to be retrieved
+      # @return [BankingAlias] the requested entity object
+      def get(id)
+        uri = provide_uri(:banking_alias_get, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      # Retrieves all banking alias entities corresponding to a waller.
+      #
+      # @param +id+ [String] ID of the banking alias to be retrieved
+      # @return [List<BankingAlias>] the requested entity object
+      def get_all(id)
+        uri = provide_uri(:banking_alias_all, id)
+        response = HttpClient.get(uri)
+        parse_results response
+      end
+
+      private
+
+      # Parses an array of JSON-originating hashes into the corresponding
+      # BankingAlias entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] parsed Mandate entity objects
+      def parse_results(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+
+      # Parses a JSON-originating hash into the corresponding
+      # BankingAlias entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [BankingAlias] corresponding BankingAlias entity object
+      def parse(response)
+        MangoModel::BankingAlias.new.dejsonify response
+      end
+    end
+  end
+end

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

@@ -1,152 +1,152 @@
-require_relative '../uri_provider'
-require_relative '../../model/request/complete_registration_request'
-require_relative '../../model/request/deactivation_request'
-
-module MangoApi
-
-  # Provides API method delegates concerning the +Card+ entity
-  module Cards
-    class << self
-      include UriProvider
-
-      # Creates a new card registration entity.
-      #
-      # +CardRegistration+ properties:
-      # * Required
-      #   * user_id
-      #   * currency
-      # * Optional
-      #   * tag
-      #   * card_type
-      #
-      # @param +card_registration+ [CardRegistration] model object of
-      # card registration to be created
-      # @param +id_key+ [String] idempotency key for future response replication
-      # @return [CardRegistration] the newly-created CardRegistration entity
-      # object
-      def create_registration(card_registration, id_key = nil)
-        uri = provide_uri(:create_card_registration)
-        response = HttpClient.post(uri, card_registration, id_key)
-        parse_registration response
-      end
-
-      # Allows completion of a card registration with the registration
-      # data received from the Tokenization Server.
-      #
-      # @param +registration_data+ [String] registration data from the
-      # Tokenization Server
-      # @return [CardRegistration] the completed CardRegistration entity
-      # object
-      def complete_registration(id, registration_data)
-        uri = provide_uri(:complete_card_registration, id)
-        request = CompleteRegistrationRequest.new(registration_data)
-        response = HttpClient.put(uri, request)
-        parse_registration response
-      end
-
-      # Retrieves a card registration entity.
-      #
-      # @param +id+ [String] ID of the card registration to retrieve
-      # @return [CardRegistration] the requested entity object
-      def get_registration(id)
-        uri = provide_uri(:get_card_registration, id)
-        response = HttpClient.get(uri)
-        parse_registration response
-      end
-
-      # Retrieves a card entity.
-      #
-      # @param +id+ [String] ID of the card entity to retrieve
-      # @return [Card] the requested Card entity object
-      def get(id)
-        uri = provide_uri(:get_card, id)
-        response = HttpClient.get(uri)
-        parse_card response
-      end
-
-      # Retrieves pages of a user's card 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
-      #
-      # @param +id+ [String] ID of the user whose cards to retrieve
-      # @return [Array] array of hashed card entities corresponding
-      # to provided filters
-      def of_user(id)
-        uri = provide_uri(:get_users_cards, id)
-        filter_request = nil
-        yield filter_request = FilterRequest.new if block_given?
-        results = HttpClient.get(uri, filter_request)
-        parse_cards results
-      end
-
-      # Retrieves pages of card entities corresponding to a
-      # certain fingerprint. The Fingerprint is a unique
-      # hash key uniquely generated per 16-digit card number.
-      #
-      # Allowed +FilterRequest+ params:
-      # * page
-      # * per_page
-      # * sort_field and sort_direction
-      #
-      # @param +fingerprint+ [String] uniquely hashed card number
-      # which to search for
-      # @return [Array] array of hashed card entities corresponding
-      # to provided filters
-      def with_fingerprint(fingerprint)
-        uri = provide_uri(:get_cards_by_fingerprint, fingerprint)
-        filter_request = nil
-        yield filter_request = FilterRequest.new if block_given?
-        results = HttpClient.get(uri, filter_request)
-        parse_cards results
-      end
-
-      # Deactivates the card entity specified by an id.
-      #
-      # @param +id+ [String] ID of the card to deactivate
-      # @return [Card] the deactivated card entity object
-      def deactivate(id)
-        uri = provide_uri(:deactivate_card, id)
-        response = HttpClient.put(uri, DeactivationRequest.new)
-        parse_card response
-      end
-
-      private
-
-      # Parses a JSON-originating hash into the corresponding
-      # CardRegistration entity object.
-      #
-      # @param +response+ [Hash] JSON-originating data hash
-      # @return [CardRegistration] corresponding CardRegistration entity object
-      def parse_registration(response)
-        MangoModel::CardRegistration.new.dejsonify response
-      end
-
-      # Parses a JSON-originating hash into the corresponding
-      # Card entity object.
-      #
-      # @param +response+ [Hash] JSON-originating data hash
-      # @return [Card] corresponding Card entity object
-      def parse_card(response)
-        MangoModel::Card.new.dejsonify response
-      end
-
-      # Parses an array of JSON-originating hashes into the corresponding
-      # Card entity objects.
-      #
-      # @param +results+ [Array] JSON-originating data hashes
-      # @return [Array] parsed Card entity objects
-      def parse_cards(results)
-        results.collect do |entity|
-          parse_card entity
-        end
-      end
-    end
-  end
+require_relative '../uri_provider'
+require_relative '../../model/request/complete_registration_request'
+require_relative '../../model/request/deactivation_request'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +Card+ entity
+  module Cards
+    class << self
+      include UriProvider
+
+      # Creates a new card registration entity.
+      #
+      # +CardRegistration+ properties:
+      # * Required
+      #   * user_id
+      #   * currency
+      # * Optional
+      #   * tag
+      #   * card_type
+      #
+      # @param +card_registration+ [CardRegistration] model object of
+      # card registration to be created
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [CardRegistration] the newly-created CardRegistration entity
+      # object
+      def create_registration(card_registration, id_key = nil)
+        uri = provide_uri(:create_card_registration)
+        response = HttpClient.post(uri, card_registration, id_key)
+        parse_registration response
+      end
+
+      # Allows completion of a card registration with the registration
+      # data received from the Tokenization Server.
+      #
+      # @param +registration_data+ [String] registration data from the
+      # Tokenization Server
+      # @return [CardRegistration] the completed CardRegistration entity
+      # object
+      def complete_registration(id, registration_data)
+        uri = provide_uri(:complete_card_registration, id)
+        request = CompleteRegistrationRequest.new(registration_data)
+        response = HttpClient.put(uri, request)
+        parse_registration response
+      end
+
+      # Retrieves a card registration entity.
+      #
+      # @param +id+ [String] ID of the card registration to retrieve
+      # @return [CardRegistration] the requested entity object
+      def get_registration(id)
+        uri = provide_uri(:get_card_registration, id)
+        response = HttpClient.get(uri)
+        parse_registration response
+      end
+
+      # Retrieves a card entity.
+      #
+      # @param +id+ [String] ID of the card entity to retrieve
+      # @return [Card] the requested Card entity object
+      def get(id)
+        uri = provide_uri(:get_card, id)
+        response = HttpClient.get(uri)
+        parse_card response
+      end
+
+      # Retrieves pages of a user's card 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
+      #
+      # @param +id+ [String] ID of the user whose cards to retrieve
+      # @return [Array] array of hashed card entities corresponding
+      # to provided filters
+      def of_user(id)
+        uri = provide_uri(:get_users_cards, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_cards results
+      end
+
+      # Retrieves pages of card entities corresponding to a
+      # certain fingerprint. The Fingerprint is a unique
+      # hash key uniquely generated per 16-digit card number.
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      #
+      # @param +fingerprint+ [String] uniquely hashed card number
+      # which to search for
+      # @return [Array] array of hashed card entities corresponding
+      # to provided filters
+      def with_fingerprint(fingerprint)
+        uri = provide_uri(:get_cards_by_fingerprint, fingerprint)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_cards results
+      end
+
+      # Deactivates the card entity specified by an id.
+      #
+      # @param +id+ [String] ID of the card to deactivate
+      # @return [Card] the deactivated card entity object
+      def deactivate(id)
+        uri = provide_uri(:deactivate_card, id)
+        response = HttpClient.put(uri, DeactivationRequest.new)
+        parse_card response
+      end
+
+      private
+
+      # Parses a JSON-originating hash into the corresponding
+      # CardRegistration entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [CardRegistration] corresponding CardRegistration entity object
+      def parse_registration(response)
+        MangoModel::CardRegistration.new.dejsonify response
+      end
+
+      # Parses a JSON-originating hash into the corresponding
+      # Card entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [Card] corresponding Card entity object
+      def parse_card(response)
+        MangoModel::Card.new.dejsonify response
+      end
+
+      # Parses an array of JSON-originating hashes into the corresponding
+      # Card entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] parsed Card entity objects
+      def parse_cards(results)
+        results.collect do |entity|
+          parse_card entity
+        end
+      end
+    end
+  end
 end