mangopay-v4 4.0.0 → 4.0.1

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

@@ -1,54 +1,54 @@
-require_relative '../uri_provider'
-
-module MangoApi
-
-  # Provides API method delegates concerning the +Transfer+ entity
-  module Transfers
-    class << self
-      include UriProvider
-
-      # Creates a new transfer entity.
-      #
-      # +Transfer+ properties:
-      # * Required
-      #   * author_id
-      #   * debited_funds
-      #   * fees
-      #   * debited_wallet_id
-      #   * credited_wallet_id
-      # * Optional
-      #   * tag
-      #   * credited_user_id
-      #
-      # @param +transfer+ [Transfer] model object of transfer to be created
-      # @param +id_key+ [String] idempotency key for future response replication
-      # @return [Transfer] the newly-created Transfer entity object
-      def create(transfer, id_key = nil)
-        uri = provide_uri(:create_transfer)
-        response = HttpClient.post(uri, transfer, id_key)
-        parse response
-      end
-
-      # Retrieves a transfer entity.
-      #
-      # @param +id+ [String] ID of the transfer to be retrieved
-      # @return [Transfer] the requested entity object
-      def get(id)
-        uri = provide_uri(:get_transfer, id)
-        response = HttpClient.get(uri)
-        parse response
-      end
-
-      private
-
-      # Parses a JSON-originating hash into the corresponding
-      # Transfer entity object.
-      #
-      # @param +response+ [Hash] JSON-originating data hash
-      # @return [Transfer] corresponding Transfer entity object
-      def parse(response)
-        MangoModel::Transfer.new.dejsonify response
-      end
-    end
-  end
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +Transfer+ entity
+  module Transfers
+    class << self
+      include UriProvider
+
+      # Creates a new transfer entity.
+      #
+      # +Transfer+ properties:
+      # * Required
+      #   * author_id
+      #   * debited_funds
+      #   * fees
+      #   * debited_wallet_id
+      #   * credited_wallet_id
+      # * Optional
+      #   * tag
+      #   * credited_user_id
+      #
+      # @param +transfer+ [Transfer] model object of transfer to be created
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [Transfer] the newly-created Transfer entity object
+      def create(transfer, id_key = nil)
+        uri = provide_uri(:create_transfer)
+        response = HttpClient.post(uri, transfer, id_key)
+        parse response
+      end
+
+      # Retrieves a transfer entity.
+      #
+      # @param +id+ [String] ID of the transfer to be retrieved
+      # @return [Transfer] the requested entity object
+      def get(id)
+        uri = provide_uri(:get_transfer, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      private
+
+      # Parses a JSON-originating hash into the corresponding
+      # Transfer entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [Transfer] corresponding Transfer entity object
+      def parse(response)
+        MangoModel::Transfer.new.dejsonify response
+      end
+    end
+  end
 end

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

@@ -1,70 +1,95 @@
-require_relative '../uri_provider'
-require_relative '../../model/request/submit_ubo_declaration_request'
-
-module MangoApi
-
-  # Provides API method delegates for the +UboDeclaration+ entity
-  module UboDeclarations
-    class << self
-      include UriProvider
-
-      # Creates a UBO Declaration entity.
-      #
-      # +UboDeclaration+ properties:
-      # * Optional
-      #   * tag
-      #   * declared_ubos
-      #
-      # @param +ubo_declaration+ [UboDeclaration] model object of the
-      # UBO declaration to be created
-      # @param +user_id+ [String] ID of the user who the declaration is
-      # being created for
-      # @return [UboDeclaration] the newly-created UboDeclaration entity object
-      def create(ubo_declaration, user_id, id_key = nil)
-        uri = provide_uri(:create_ubo_declaration, user_id)
-        response = HttpClient.post(uri, ubo_declaration, id_key)
-        parse response
-      end
-
-      # Updates the UBO declaration entity identifiable by the provided
-      # +UboDeclaration+ object's ID.
-      #
-      # +UboDeclaration+ optional properties:
-      # * tag
-      # * status
-      # * declared_ubos
-      #
-      # @param +ubo_declaration+ [UboDeclaration] UBO declaration object
-      # with corresponding ID and updated data
-      # @return [UboDeclaration] the updated UboDeclaration entity object
-      def update(ubo_declaration)
-        uri = provide_uri(:update_ubo_declaration, ubo_declaration.id)
-        response = HttpClient.put(uri, ubo_declaration)
-        parse response
-      end
-
-      # Submits a UBO declaration entity for approval.
-      #
-      # @param +id+ [String] ID of the UBO declaration to submit
-      # @param +tag+ [String] custom data to add with the request
-      # @return [UboDeclaration] the submitted UboDeclaration entity object
-      def submit(id, tag = nil)
-        uri = provide_uri(:submit_ubo_declaration, id)
-        submit_request = SubmitUboDeclarationRequest.new(tag)
-        response = HttpClient.put(uri, submit_request)
-        parse response
-      end
-
-      private
-
-      # Parses a JSON-originating hash into the corresponding
-      # UboDeclaration entity object.
-      #
-      # @param +response+ [Hash] JSON-originating data hash
-      # @return [UboDeclaration] corresponding UboDeclaration entity object
-      def parse(response)
-        MangoModel::UboDeclaration.new.dejsonify response
-      end
-    end
-  end
+require_relative '../uri_provider'
+require_relative '../../model/request/submit_ubo_declaration_request'
+
+module MangoApi
+
+  # Provides API method delegates for the +UboDeclaration+ entity
+  module UboDeclarations
+    class << self
+      include UriProvider
+
+      # Creates a UBO Declaration entity.
+      #
+      # +UboDeclaration+ properties:
+      # * Optional
+      #   * tag
+      #   * declared_ubos
+      #
+      # @param +user_id+ [String] ID of the user who the declaration is
+      # being created for
+      # @return [UboDeclaration] the newly-created UboDeclaration entity object
+      def create(user_id, id_key = nil)
+        uri = provide_uri(:create_ubo_declaration, user_id)
+        response = HttpClient.post(uri, nil, id_key)
+        parse response
+      end
+
+      def get_all(user_id, id_key = nil)
+        uri = provide_uri(:all_ubo_declaration, user_id)
+        response = HttpClient.get(uri, id_key)
+        parse_ubo_declarations response
+      end
+
+      def get(user_id, ubo_declaration_id, id_key = nil)
+        uri = if user_id != nil
+                provide_uri(:get_ubo_declaration, user_id, ubo_declaration_id)
+              else
+                provide_uri(:get_ubo_declaration_by_id, ubo_declaration_id)
+              end
+        response = HttpClient.get(uri, id_key)
+        parse response
+      end
+
+      def create_ubo(user_id, ubo_declaration_id, ubo, id_key = nil)
+        uri = provide_uri(:create_ubo, user_id, ubo_declaration_id)
+        response = HttpClient.post(uri, ubo, id_key)
+        parseUbo response
+      end
+
+      def update_ubo(user_id, ubo_declaration_id, ubo)
+        uri = provide_uri(:update_ubo, user_id, ubo_declaration_id, ubo.id)
+        response = HttpClient.put(uri, ubo)
+        parseUbo response
+      end
+
+      def get_ubo(user_id, ubo_declaration_id, ubo_id, id_key = nil)
+        uri = provide_uri(:get_ubo, user_id, ubo_declaration_id, ubo_id)
+        response = HttpClient.get(uri, id_key)
+        parseUbo response
+      end
+
+      # Submits a UBO declaration entity for approval.
+      #
+      # @param +id+ [String] ID of the UBO declaration to submit
+      # @param +tag+ [String] custom data to add with the request
+      # @return [UboDeclaration] the submitted UboDeclaration entity object
+      def submit(user_id, ubo_declaration_id, tag = nil)
+        uri = provide_uri(:submit_ubo_declaration, user_id, ubo_declaration_id)
+        submit_request = SubmitUboDeclarationRequest.new(ubo_declaration_id, tag)
+        response = HttpClient.put(uri, submit_request)
+        parse response
+      end
+
+      private
+
+      # Parses a JSON-originating hash into the corresponding
+      # UboDeclaration entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [UboDeclaration] corresponding UboDeclaration entity object
+      def parse(response)
+        MangoModel::UboDeclaration.new.dejsonify response
+      end
+
+      def parse_ubo_declarations(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+
+      def parseUbo(response)
+        MangoModel::Ubo.new.dejsonify response
+      end
+    end
+  end
 end

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

@@ -1,163 +1,163 @@
-require_relative '../uri_provider'
-require_relative '../../model/request/filter_request'
-
-module MangoApi
-
-  # Provides API method delegates concerning the +User+ entity.
-  module Users
-    class << self
-      include UriProvider
-
-      # Creates a new user entity.
-      #
-      # +User+ properties:
-      # * +NaturalUser+
-      #   * +first_name+ - required
-      #   * +last_name+ - required
-      #   * +birthday+ - required
-      #   * +nationality+ - required
-      #   * +country_of_residence+ - required
-      #   * +email+ - required
-      #   * +tag+ - optional
-      #   * +address+ - optional
-      #   * +occupation+ - optional
-      #   * +income_range+ - optional
-      #   * +capacity+ - optional
-      # * +LegalUser+
-      #   * +legal_person_type+ - required
-      #   * +name+ - required
-      #   * +legal_representative_birthday+ - required
-      #   * +legal_representative_country_of_residence+ - required
-      #   * +legal_representative_nationality+ - required
-      #   * +legal_representative_first_name+ - required
-      #   * +legal_representative_last_name+ - required
-      #   * +email+ - required
-      #   * +tag+ - optional
-      #   * +headquarters_address+ - optional
-      #   * +legal_representative_address+ - optional
-      #   * +legal_representative_email+ - optional
-      #   * +company_number+ - optional
-      #
-      # +User+ properties:
-      # * Optional
-      #   * tag
-      #   * declared_ubos
-      #
-      # @param +user+ [User] model object of user to be created
-      # @param +id_key+ [String] idempotency key for future response replication
-      # @return [User] the newly-created User entity object
-      def create(user, id_key = nil)
-        uri = provide_uri(:create_user, user)
-        response = HttpClient.post(uri, user, id_key)
-        parse response
-      end
-
-      # Updates the user entity identifiable by
-      # the provided user object's ID.
-      #
-      # +User+ optional properties:
-      # * +NaturalUser+
-      #   * tag
-      #   * first_name
-      #   * last_name
-      #   * address
-      #   * birthday
-      #   * nationality
-      #   * country_of_residence
-      #   * occupation
-      #   * income_range
-      #   * email
-      # * +Legal_user+
-      #   * tag
-      #   * headquarters_address
-      #   * name
-      #   * legal_representative_address
-      #   * legal_representative_birthday
-      #   * legal_representative_country_of_residence
-      #   * legal_representative_nationality
-      #   * legal_representative_email
-      #   * legal_representative_first_name
-      #   * legal_representative_last_name
-      #   * legal_person_type
-      #   * company_number
-      #
-      # @param +user+ [User] user object with corresponding ID
-      # and updated data
-      # @return [User] the updated User entity object
-      def update(user)
-        uri = provide_uri :update_user,
-                          user.person_type.to_s.downcase,
-                          user.id
-        response = HttpClient.put(uri, user)
-        parse response
-      end
-
-      # Retrieves a user entity.
-      #
-      # @param +id+ [String] ID of the user to be retrieved
-      # @return [User] the requested entity object
-      def get(id)
-        uri = provide_uri(:get_user, id)
-        response = HttpClient.get(uri)
-        parse response
-      end
-
-      # Retrieves user entity pages. 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
-      # * before_date
-      # * after_date
-      #
-      # @return [Array] corresponding User entity objects
-      def all
-        uri = provide_uri(:get_users)
-        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
-      # User entity objects.
-      #
-      # @param +results+ [Array] JSON-originating data hashes
-      # @return [Array] parsed User entity objects
-      def parse_results(results)
-        results.collect do |entity|
-          parse entity
-        end
-      end
-
-      # Parses a JSON-originating hash into the corresponding
-      # User entity object.
-      #
-      # @param +response+ [Hash] JSON-originating data hash
-      # @return [User] corresponding User entity object
-      def parse(response)
-        type = user_type(response)
-        type.new.dejsonify response
-      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 MangoModel::PersonType::NATURAL.to_s
-          MangoModel::NaturalUser
-        else
-          MangoModel::LegalUser
-        end
-      end
-    end
-  end
+require_relative '../uri_provider'
+require_relative '../../model/request/filter_request'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +User+ entity.
+  module Users
+    class << self
+      include UriProvider
+
+      # Creates a new user entity.
+      #
+      # +User+ properties:
+      # * +NaturalUser+
+      #   * +first_name+ - required
+      #   * +last_name+ - required
+      #   * +birthday+ - required
+      #   * +nationality+ - required
+      #   * +country_of_residence+ - required
+      #   * +email+ - required
+      #   * +tag+ - optional
+      #   * +address+ - optional
+      #   * +occupation+ - optional
+      #   * +income_range+ - optional
+      #   * +capacity+ - optional
+      # * +LegalUser+
+      #   * +legal_person_type+ - required
+      #   * +name+ - required
+      #   * +legal_representative_birthday+ - required
+      #   * +legal_representative_country_of_residence+ - required
+      #   * +legal_representative_nationality+ - required
+      #   * +legal_representative_first_name+ - required
+      #   * +legal_representative_last_name+ - required
+      #   * +email+ - required
+      #   * +tag+ - optional
+      #   * +headquarters_address+ - optional
+      #   * +legal_representative_address+ - optional
+      #   * +legal_representative_email+ - optional
+      #   * +company_number+ - optional
+      #
+      # +User+ properties:
+      # * Optional
+      #   * tag
+      #   * declared_ubos
+      #
+      # @param +user+ [User] model object of user to be created
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [User] the newly-created User entity object
+      def create(user, id_key = nil)
+        uri = provide_uri(:create_user, user)
+        response = HttpClient.post(uri, user, id_key)
+        parse response
+      end
+
+      # Updates the user entity identifiable by
+      # the provided user object's ID.
+      #
+      # +User+ optional properties:
+      # * +NaturalUser+
+      #   * tag
+      #   * first_name
+      #   * last_name
+      #   * address
+      #   * birthday
+      #   * nationality
+      #   * country_of_residence
+      #   * occupation
+      #   * income_range
+      #   * email
+      # * +Legal_user+
+      #   * tag
+      #   * headquarters_address
+      #   * name
+      #   * legal_representative_address
+      #   * legal_representative_birthday
+      #   * legal_representative_country_of_residence
+      #   * legal_representative_nationality
+      #   * legal_representative_email
+      #   * legal_representative_first_name
+      #   * legal_representative_last_name
+      #   * legal_person_type
+      #   * company_number
+      #
+      # @param +user+ [User] user object with corresponding ID
+      # and updated data
+      # @return [User] the updated User entity object
+      def update(user)
+        uri = provide_uri :update_user,
+                          user.person_type.to_s.downcase,
+                          user.id
+        response = HttpClient.put(uri, user)
+        parse response
+      end
+
+      # Retrieves a user entity.
+      #
+      # @param +id+ [String] ID of the user to be retrieved
+      # @return [User] the requested entity object
+      def get(id)
+        uri = provide_uri(:get_user, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      # Retrieves user entity pages. 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
+      # * before_date
+      # * after_date
+      #
+      # @return [Array] corresponding User entity objects
+      def all
+        uri = provide_uri(:get_users)
+        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
+      # User entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] parsed User entity objects
+      def parse_results(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+
+      # Parses a JSON-originating hash into the corresponding
+      # User entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [User] corresponding User entity object
+      def parse(response)
+        type = user_type(response)
+        type.new.dejsonify response
+      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 MangoModel::PersonType::NATURAL.to_s
+          MangoModel::NaturalUser
+        else
+          MangoModel::LegalUser
+        end
+      end
+    end
+  end
 end