mangopay-v4 4.0.0

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

@@ -0,0 +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
+end

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

@@ -0,0 +1,89 @@
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +ClientWallet+ entity
+  module ClientWallets
+    class << self
+      include UriProvider
+
+      # Retrieves a client wallet entity.
+      # Client wallet entity of provided funds' type and currency will be
+      # created if it does not yet exist.
+      #
+      # @param +funds_type+ [FundsType] funds' type of the wallet to retrieve
+      # @param +currency+ [CurrencyIso] currency of the wallet to retrieve
+      # @return [ClientWallet] the corresponding ClientWallet entity object
+      def get(funds_type, currency)
+        uri = provide_uri(:get_client_wallet, funds_type, currency)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      # Retrieves client wallet 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
+      #
+      # @return [Array] array of hashed client wallet entities
+      # corresponding to provided filters
+      def all
+        uri = provide_uri(:get_client_wallets)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Retrieves client wallet entities of a certain funds type.
+      # 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 +funds_type+ [FundsType] funds' type of the client
+      # wallets to retrieve
+      # @return [Array] array of hashed client wallet entities
+      # corresponding to provided filters
+      def of_funds_type(funds_type)
+        uri = provide_uri(:get_client_wallets_funds_type, funds_type)
+        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
+      # ClientWallet entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] parsed ClientWallet entity objects
+      def parse_results(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+
+      # Parses a JSON-originating hash into the corresponding
+      # ClientWallet entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [ClientWallet] corresponding ClientWallet entity object
+      def parse(response)
+        MangoModel::ClientWallet.new.dejsonify response
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+require_relative '../uri_provider'
+require_relative '../../util/file_encoder'
+require_relative '../../model/request/upload_file_request'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +Client+ entity
+  module Clients
+    class << self
+      include UriProvider
+
+      # Updates the current environment's client entity.
+      #
+      # +Client+ optional properties:
+      # * primary_button_colour
+      # * primary_theme_colour
+      # * admin_emails
+      # * tech_emails
+      # * billing_emails
+      # * fraud_emails
+      # * headquarters_address
+      # * tax_number
+      # * platform_type
+      # * platform_description
+      # * platform_url
+      #
+      # @param +client+ [Client] client object with corresponding ID
+      # and updated dat
+      # @return [Client] updated Client entity object
+      def update(client)
+        uri = provide_uri(:update_client)
+        response = HttpClient.put(uri, client)
+        parse response
+      end
+
+      # Uploads the image file specified as the current
+      # environment's client's logo.
+      #
+      # @param +path+ [String] path of the logo image
+      def upload_logo(path)
+        uri = provide_uri(:upload_client_logo)
+        body = UploadFileRequest.new
+        body.file = FileEncoder.encode_base64 path
+        HttpClient.put(uri, body)
+      end
+
+      # Retrieves the current environment's client entity.
+      #
+      # @return [Client] current Client entity object
+      def get
+        uri = provide_uri(:get_client)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      private
+
+      # Parses a JSON-originating hash into the corresponding
+      # Client entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [Client] corresponding Client entity object
+      def parse(response)
+        MangoModel::Client.new.dejsonify response
+      end
+    end
+  end
+end

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

@@ -0,0 +1,158 @@
+require_relative '../uri_provider'
+require_relative '../../model/request/upload_file_request'
+require_relative '../../util/file_encoder'
+require_relative '../../model/request/submit_document_request'
+
+module MangoApi
+
+  # Provides API method delegates for the +DisputeDocument+ entity
+  module DisputeDocuments
+    class << self
+      include UriProvider
+
+      # Creates a new dispute document entity.
+      #
+      # +DisputeDocument+ properties:
+      # * Required
+      #   * type
+      # * Optional
+      #   * tag
+      #
+      # @param +document+ [DisputeDocument] model object of the dispute
+      # document to be created
+      # @param +dispute_id+ [String] ID of the corresponding dispute
+      # @return [DisputeDocument] the newly-created DisputeDocument entity object
+      def create(document, dispute_id)
+        uri = provide_uri(:create_dispute_document, dispute_id)
+        response = HttpClient.post(uri, document)
+        parse response
+      end
+
+      # Uploads a dispute document page. Allowed extensions:
+      # .pdf .jpeg .jpg .gif .png
+      #
+      # @param +id+ [String] ID of the dispute document entity
+      # that the page is being uploaded for
+      # @param +dispute_id+ [String] ID of the corresponding dispute entity
+      # @param +path+ [String] path to the file to upload
+      def upload_page(id, dispute_id, path)
+        uri = provide_uri(:upload_dispute_document_page, dispute_id, id)
+        body = UploadFileRequest.new
+        body.file = FileEncoder.encode_base64 path
+        HttpClient.post(uri, body)
+      end
+
+      # Submits a dispute document entity for approval
+      #
+      # @param +id+ [String] ID of the dispute document to submit
+      # @param +dispute_id+ [String] ID of the corresponding dispute
+      # @return [DisputeDocument] the submitted DisputeDocument entity object
+      def submit(id, dispute_id)
+        uri = provide_uri(:submit_dispute_document, dispute_id, id)
+        request = SubmitDocumentRequest.new
+        response = HttpClient.put(uri, request)
+        parse response
+      end
+
+      # Retrieves a dispute document entity.
+      #
+      # @param +id+ [String] ID of the dispute document to retrieve
+      # @return [DisputeDocument] the requested DisputeDocument entity object
+      def get(id)
+        uri = provide_uri(:get_dispute_document, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      # Retrieves dispute documents belonging to a certain dispute.
+      # 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
+      # * status
+      # * type
+      #
+      # @param +id+ [String] ID of the dispute whose documents to retrieve
+      # @return [Array] corresponding DisputeDocument entity objects
+      def of_dispute(id)
+        uri = provide_uri(:get_disputes_documents, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Retrieves dispute documents belonging to the current environment's
+      # client. 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
+      # * status
+      # * type
+      #
+      # @return [Array] corresponding DisputeDocument entity objects
+      def all
+        uri = provide_uri(:get_dispute_documents)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Creates temporary URLs where each page of a dispute document
+      # can be viewed
+      #
+      # @param +id+ [String] ID of the document whose pages to consult
+      # @return [Array] the corresponding DocumentPageConsult objects
+      def consult(id)
+        uri = provide_uri(:consult_dispute_document, id)
+        results = HttpClient.post(uri, nil)
+        parse_consults results
+      end
+
+      private
+
+      # Parses an array of JSON-originating hashes into the corresponding
+      # DisputeDocument entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] parsed DisputeDocument entity objects
+      def parse_results(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+
+      # Parses a JSON-originating hash into the corresponding
+      # DisputeDocument entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [DisputeDocument] corresponding DisputeDocument entity object
+      def parse(response)
+        MangoModel::DisputeDocument.new.dejsonify response
+      end
+      # Parses an array of JSON-originating hashes into the corresponding
+      # DocumentPageConsult objects.
+      #
+      # @param +consults+ [Array] JSON-originating data hashes
+      # @return [Array] corresponding DocumentPageConsult objects
+      def parse_consults(consults)
+        consults.collect do |consult|
+          MangoModel::DocumentPageConsult.new.dejsonify consult
+        end
+      end
+    end
+  end
+end