mangopay4-ruby-sdk 3.44.0

data/lib/mangopay/mandate.rb

@@ -0,0 +1,42 @@
+module MangoPay
+
+  # See https://docs.mangopay.com/api-references/mandates/
+  class Mandate < Resource
+    include HTTPCalls::Fetch
+
+    class << self
+
+      # +params+: hash; see https://docs.mangopay.com/api-references/mandates/
+      def create(params, idempotency_key = nil)
+        url = "#{MangoPay.api_path}/mandates/directdebit/web"
+        MangoPay.request(:post, url, params, {}, idempotency_key)
+      end
+
+      def cancel(id)
+        url = "#{MangoPay.api_path}/mandates/#{id}/cancel"
+        MangoPay.request(:put, url)
+      end
+
+      def fetch_for_user(user_id, filters = {})
+        url = "#{MangoPay.api_path}/users/#{user_id}/mandates"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
+      def fetch_for_user_bank_account(user_id, bank_account_id, filters = {})
+        url = "#{MangoPay.api_path}/users/#{user_id}/bankaccounts/#{bank_account_id}/mandates"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
+      # Fetches list of transactions belonging to given +mandate_id+.
+      #
+      # Optional +filters+ is a hash accepting following keys:
+      # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+      # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
+      # - +ResultCode+: string representing the transaction result
+      def transactions(mandate_id, filters = {})
+        url = url(mandate_id) + '/transactions'
+        MangoPay.request(:get, url, {}, filters)
+      end
+    end
+  end
+end

data/lib/mangopay/natural_user.rb

@@ -0,0 +1,20 @@
+module MangoPay
+
+  # See http://docs.mangopay.com/api-references/users/natural-users/
+  class NaturalUser < User
+
+    def self.url(id = nil)
+      if id
+        "#{MangoPay.api_path}/users/natural/#{CGI.escape(id.to_s)}"
+      else
+        "#{MangoPay.api_path}/users/natural"
+      end
+    end
+
+    class << self
+      def close(user_id)
+        MangoPay.request(:delete, url(user_id))
+      end
+    end
+  end
+end

data/lib/mangopay/natural_user_sca.rb

@@ -0,0 +1,25 @@
+module MangoPay
+
+  # See https://docs.mangopay.com/api-reference/users/natural-user-object-sca
+  class NaturalUserSca < User
+
+    def self.url(id = nil)
+      if id
+        "#{MangoPay.api_path}/sca/users/natural/#{CGI.escape(id.to_s)}"
+      else
+        "#{MangoPay.api_path}/sca/users/natural"
+      end
+    end
+
+    class << self
+      def categorize(user_id, params)
+        url = "#{MangoPay.api_path}/sca/users/natural/#{user_id}/category"
+        MangoPay.request(:put, url, params)
+      end
+
+      def close(user_id)
+        MangoPay.request(:delete, url(user_id))
+      end
+    end
+  end
+end

data/lib/mangopay/pay_in.rb

@@ -0,0 +1,415 @@
+module MangoPay
+
+  # See http://docs.mangopay.com/api-references/payins/
+  class PayIn < Resource
+    include HTTPCalls::Fetch
+    include HTTPCalls::Refund
+
+    # Fetches list of refunds belonging to the given +pay_in_id+.
+    #
+    # Optional +filters+ is a hash accepting following keys:
+    # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+    # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
+    # - +ResultCode+: string representing the transaction result
+    def self.refunds(pay_in_id, filters = {})
+      url = url(pay_in_id) + '/refunds'
+      MangoPay.request(:get, url, {}, filters)
+    end
+
+    module Card
+
+      # See http://docs.mangopay.com/api-references/payins/payins-card-web/
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/card/#{CGI.escape(class_name.downcase)}"
+        end
+
+        def self.extended(pay_in_id)
+          MangoPay.request(:get, extended_url(pay_in_id), {}, {})
+        end
+
+        # See https://docs.mangopay.com/endpoints/v2.01/payins#e847_view-card-details-for-a-payin-web
+        # example: data = MangoPay::PayIn::Card::Web.extended(12639078)
+        def self.extended_url(pay_in_id)
+          escaped_pay_in_id = CGI.escape(pay_in_id.to_s)
+          "#{MangoPay.api_path}/payins/card/web/#{escaped_pay_in_id}/extended"
+        end
+      end
+
+      # See http://docs.mangopay.com/api-references/payins/payindirectcard/
+      class Direct < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/card/#{CGI.escape(class_name.downcase)}"
+        end
+      end
+
+    end
+
+    module PreAuthorized
+
+      # See http://docs.mangopay.com/api-references/payins/preauthorized-payin/
+      class Direct < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/preauthorized/direct"
+        end
+
+        def self.create_pre_authorized_deposit_pay_in(params, idempotency_key = nil)
+          MangoPay.request(:post, "#{MangoPay.api_path}/payins/deposit-preauthorized/direct/full-capture", params, {}, idempotency_key)
+        end
+
+        def self.create_deposit_preauthorized_pay_in_prior_to_complement(params, idempotency_key = nil)
+          MangoPay.request(:post, "#{MangoPay.api_path}/payins/deposit-preauthorized/direct/capture-with-complement", params, {}, idempotency_key)
+        end
+
+        def self.create_deposit_preauthorized_pay_in_complement(params, idempotency_key = nil)
+          MangoPay.request(:post, "#{MangoPay.api_path}/payins/deposit-preauthorized/direct/complement", params, {}, idempotency_key)
+        end
+      end
+
+    end
+
+    module BankWire
+
+      # See http://docs.mangopay.com/api-references/payins/payinbankwire/
+      class Direct < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/bankwire/direct"
+        end
+      end
+
+      class ExternalInstruction < Resource
+      end
+
+    end
+
+    module DirectDebit
+
+      # See http://docs.mangopay.com/api-references/payins/direct-debit-pay-in-web/
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/directdebit/#{CGI.escape(class_name.downcase)}"
+        end
+      end
+
+      # See https://docs.mangopay.com/api-references/payins/direct-debit-pay-in-direct/
+      class Direct < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/directdebit/#{CGI.escape(class_name.downcase)}"
+        end
+      end
+
+    end
+
+    module PayPal
+
+      # See https://docs.mangopay.com/api-references/payins/paypal-payin/
+      # # <b>DEPRECATED</b>: 'create' function is now deprecated.
+      # Please use the 'create_v2' function - MangoPay::PayIn::PayPal::Web.create_new(params)
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/paypal/#{CGI.escape(class_name.downcase)}"
+        end
+
+        def self.create_v2(params, idempotency_key = nil)
+          MangoPay.request(:post, "#{MangoPay.api_path}/payins/payment-methods/paypal", params, {}, idempotency_key)
+        end
+
+        # Add tracking information to a PayPal PayIn (add the tracking number and carrier for LineItems shipments.)
+        # Caution – Tracking information cannot be edited
+        # You can’t modify the TrackingNumber, Carrier, or NotifyBuyer once added.
+        # You can only send a unique tracking number once.
+        def self.add_paypal_tracking_information(pay_in_id, params, idempotency_key = nil)
+          MangoPay.request(:put, "#{MangoPay.api_path}/payins/#{pay_in_id}/trackings", params, {}, idempotency_key)
+        end
+
+        def self.create_data_collection(params, idempotency_key = nil)
+          MangoPay.request(:post, "#{MangoPay.api_path}/payins/payment-methods/paypal/data-collection", params, {}, idempotency_key)
+        end
+
+        def self.get_data_collection(data_collection_id, idempotency_key = nil)
+          MangoPay.request(:get, "#{MangoPay.api_path}/payins/payment-methods/paypal/data-collection/#{data_collection_id}")
+        end
+      end
+
+    end
+
+    module Payconiq
+
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/payconiq"
+        end
+
+        def self.create_legacy(params, idempotency_key = nil)
+          MangoPay.request(:post, "#{MangoPay.api_path}/payins/payconiq/web", params, {}, idempotency_key)
+        end
+      end
+
+    end
+
+    module ApplePay
+      class Direct < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/applepay/#{CGI.escape(class_name.downcase)}"
+        end
+      end
+    end
+
+    module GooglePay
+      class Direct < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/googlepay"
+        end
+      end
+    end
+
+    module Mbway
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/mbway"
+        end
+      end
+    end
+
+    module Multibanco
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/multibanco"
+        end
+      end
+    end
+
+    module Blik
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/blik"
+        end
+      end
+    end
+
+    module Satispay
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/satispay"
+        end
+      end
+    end
+
+    module Klarna
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/klarna"
+        end
+      end
+    end
+
+    module Ideal
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/ideal"
+        end
+      end
+    end
+
+    module Giropay
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/giropay"
+        end
+      end
+    end
+
+    module Bancontact
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/bancontact"
+        end
+      end
+    end
+
+    module Bizum
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/bizum"
+        end
+      end
+    end
+
+    module Twint
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/twint"
+        end
+      end
+    end
+
+    module Swish
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/swish"
+        end
+      end
+    end
+
+    module PayByBank
+      class Web < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/openbanking"
+        end
+
+        class << self
+          def get_supported_banks(filters = {})
+            MangoPay.request(:get, "#{MangoPay.api_path}/payment-methods/openbanking/metadata/supported-banks", {}, filters)
+          end
+        end
+      end
+    end
+
+    module RecurringPayments
+      class Recurring < Resource
+        include HTTPCalls::Create
+        include HTTPCalls::Fetch
+        include HTTPCalls::Update
+
+        def self.url(*args)
+          if args.any?
+            "#{MangoPay.api_path}/recurringpayinregistrations/#{args.first}"
+          else
+            "#{MangoPay.api_path}/recurringpayinregistrations"
+          end
+        end
+      end
+
+      class CIT < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/recurring/card/direct"
+        end
+      end
+
+      class MIT < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/recurring/card/direct"
+        end
+      end
+
+      class PayPalCIT < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/paypal/recurring"
+        end
+      end
+
+      class PayPalMIT < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/payment-methods/paypal/recurring"
+        end
+      end
+    end
+
+    module PayInIntent
+      class Authorization < Resource
+        class << self
+          def create(params, idempotency_key = nil)
+            MangoPay.request(:post, "#{MangoPay.api_path_v3}/payins/intents", params, {}, idempotency_key)
+          end
+        end
+      end
+
+      class Capture < Resource
+        class << self
+          def create(intent_id, params, idempotency_key = nil)
+            MangoPay.request(:post, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}/captures", params, {}, idempotency_key)
+          end
+        end
+      end
+
+      class Intent < Resource
+        class << self
+          def get(intent_id)
+            MangoPay.request(:get, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}")
+          end
+
+          def cancel(intent_id, params, idempotency_key = nil)
+            MangoPay.request(:post, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}/cancel", params, {}, idempotency_key)
+          end
+        end
+      end
+
+      class Split < Resource
+        class << self
+          def create(intent_id, params, idempotency_key = nil)
+            MangoPay.request(:post, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}/splits", params, {}, idempotency_key)
+          end
+
+          def execute(intent_id, split_id, idempotency_key = nil)
+            MangoPay.request(:post, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}/splits/#{split_id}/execute", {}, {}, idempotency_key)
+          end
+
+          def reverse(intent_id, split_id, idempotency_key = nil)
+            MangoPay.request(:post, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}/splits/#{split_id}/reverse", {}, {}, idempotency_key)
+          end
+
+          def get(intent_id, split_id)
+            MangoPay.request(:get, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}/splits/#{split_id}")
+          end
+
+          def update(intent_id, split_id, params)
+            MangoPay.request(:put, "#{MangoPay.api_path_v3}/payins/intents/#{intent_id}/splits/#{split_id}", params)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/mangopay/pay_out.rb

@@ -0,0 +1,41 @@
+module MangoPay
+  class PayOut < Resource
+    include HTTPCalls::Fetch
+
+    # Fetches list of refunds belonging to the given +pay_out_id+.
+    #
+    # Optional +filters+ is a hash accepting following keys:
+    # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+    # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
+    # - +ResultCode+: string representing the transaction result
+    def self.refunds(pay_out_id, filters = {}, idempotency_key = nil)
+      url = url(pay_out_id) + '/refunds'
+      MangoPay.request(:get, url, {}, filters, idempotency_key)
+    end
+
+    # See http://docs.mangopay.com/api-references/pay-out-bank-wire/
+    class BankWire < Resource
+      include HTTPCalls::Create
+
+      def self.url(*)
+        "#{MangoPay.api_path}/payouts/bankwire"
+      end
+
+      def self.get_bankwire(pay_out_id)
+        url = self.url() + "/" + pay_out_id
+        MangoPay.request(:get, url);
+      end
+    end
+
+    # See https://docs.mangopay.com/endpoints/v2.01/payouts#e1058_check-instant-payout-eligibility
+    module InstantPayoutEligibility
+      class Reachability < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payouts/reachability"
+        end
+      end
+    end
+  end
+end

data/lib/mangopay/payment_method_metadata.rb

@@ -0,0 +1,13 @@
+module MangoPay
+  class PaymentMethodMetadata < Resource
+    include HTTPCalls::Fetch
+    include HTTPCalls::Update
+
+    class << self
+      def get_metadata(metadata)
+        url = "#{MangoPay.api_path}/payment-methods/metadata"
+        MangoPay.request(:post, url, metadata)
+      end
+    end
+  end
+end

data/lib/mangopay/pre_authorization.rb

@@ -0,0 +1,17 @@
+module MangoPay
+
+  # See http://docs.mangopay.com/api-references/payins/preauthorized-payin/
+  class PreAuthorization < Resource
+    include HTTPCalls::Update
+    include HTTPCalls::Fetch
+
+    def self.create(params, idempotency_key = nil)
+      MangoPay.request(:post, "#{url}/card/direct", params, {}, idempotency_key)
+    end
+
+    def self.transactions(pre_authorization_id, filters = {})
+      MangoPay.request(:get, "#{url}/#{pre_authorization_id}/transactions", {}, filters)
+    end
+
+  end
+end

data/lib/mangopay/recipient.rb

@@ -0,0 +1,35 @@
+module MangoPay
+
+  class Recipient < Resource
+    def self.create(params, user_id, idempotency_key = nil)
+      MangoPay.request(:post, "#{MangoPay.api_path}/users/#{user_id}/recipients", params, {}, idempotency_key)
+    end
+
+    def self.get(recipient_id, filters = {})
+      MangoPay.request(:get, "#{MangoPay.api_path}/recipients/#{recipient_id}", {}, filters)
+    end
+
+    def self.get_user_recipients(user_id, filters = {})
+      MangoPay.request(:get, "#{MangoPay.api_path}/users/#{user_id}/recipients", {}, filters)
+    end
+
+    def self.get_schema(payout_method_type, recipient_type, currency, country, filters = {})
+      MangoPay.request(:get, "#{MangoPay.api_path}/recipients/schema?payoutMethodType=#{payout_method_type}&recipientType=#{recipient_type}&currency=#{currency}&country=#{country}", {}, filters)
+    end
+
+    def self.get_payout_methods(country, currency, filters = {})
+      MangoPay.request(:get, "#{MangoPay.api_path}/recipients/payout-methods?country=#{country}&currency=#{currency}", {}, filters)
+    end
+
+    def self.validate(params, user_id, idempotency_key = nil)
+      MangoPay.request(:post, "#{MangoPay.api_path}/users/#{user_id}/recipients/validate", params, {}, idempotency_key)
+    end
+
+    def self.deactivate(recipient_id)
+      params = {
+        Status: 'DEACTIVATED'
+      }
+      MangoPay.request(:put, "#{MangoPay.api_path}/recipients/#{recipient_id}", params, {})
+    end
+  end
+end

data/lib/mangopay/refund.rb

@@ -0,0 +1,19 @@
+module MangoPay
+
+  # See http://docs.mangopay.com/api-references/refund/
+  class Refund < Resource
+    include HTTPCalls::Create
+    include HTTPCalls::Fetch
+
+    # Fetches list of refunds belonging to given +repudiation_id+
+    #
+    # Optional +filters+ is a hash accepting following keys:
+    # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+    # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
+    # - +ResultCode+: string representing the transaction result
+    def self.of_repudiation(repudiation_id, filters = {})
+      url = "#{MangoPay.api_path}/repudiations/#{repudiation_id}/refunds"
+      MangoPay.request(:get, url, {}, filters)
+    end
+  end
+end

data/lib/mangopay/regulatory.rb

@@ -0,0 +1,22 @@
+module MangoPay
+  # Provides API methods for the UBO entity.
+  class Regulatory < Resource
+    class << self
+      def one_country_url(country_iso)
+        "#{MangoPay.api_path_no_client}/countries/#{country_iso}/authorizations"
+      end
+
+      def all_countries_url
+        "#{MangoPay.api_path_no_client}/countries/authorizations"
+      end
+
+      def get_country_authorizations(country_iso)
+        MangoPay.request(:get, one_country_url(country_iso))
+      end
+
+      def get_all_countries_authorizations
+        MangoPay.request(:get, all_countries_url)
+      end
+    end
+  end
+end

data/lib/mangopay/report.rb

@@ -0,0 +1,24 @@
+module MangoPay
+
+  # See https://docs.mangopay.com/endpoints/v2.01/reporting
+  class Report < Resource
+    include HTTPCalls::Fetch
+
+    class << self
+
+      # +params+: hash; see https://docs.mangopay.com/endpoints/v2.01/reporting#e825_create-a-transaction-report
+      def create(params, idempotency_key = nil)
+        if params[:ReportType] == 'transactions'
+          url = url() + '/transactions/'
+        elsif params[:ReportType] == 'wallets'
+          url = url() + '/wallets/'
+        else
+          raise 'When creating a report, ReportType is required. Ex: ("transactions", "wallets")'
+        end
+
+        MangoPay.request(:post, url, params, {}, idempotency_key)
+      end
+
+    end
+  end
+end