checkout_sdk 0.3.2 → 1.0.0.beta.0

data/lib/checkout_sdk/payments/payer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute name
+    #   @return [String]
+    # @!attribute email
+    #   @return [String]
+    # @!attribute document
+    #   @return [String]
+    class Payer
+      attr_accessor :name,
+                    :email,
+                    :document
+    end
+  end
+end

data/lib/checkout_sdk/payments/payment_instruction.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute purpose
+    #   @return [String]
+    # @!attribute charge_bearer
+    #   @return [String] {ChargeBearer}
+    # @!attribute repair
+    #   @return [TrueClass, FalseClass]
+    # @!attribute scheme
+    #   @return [String] {InstructionScheme}
+    # @!attribute quote_id
+    #   @return [String]
+    # @!attribute skip_expiry
+    #   @return [TrueClass, FalseClass]
+    # @!attribute funds_transfer_type
+    #   @return [String]
+    # @!attribute mvv
+    #   @return [String]
+    class PaymentInstruction
+      attr_accessor :purpose,
+                    :charge_bearer,
+                    :repair,
+                    :scheme,
+                    :quote_id,
+                    :skip_expiry,
+                    :funds_transfer_type,
+                    :mvv
+    end
+  end
+end

data/lib/checkout_sdk/payments/payment_recipient.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute dob
+    #   @return [String]
+    # @!attribute account_number
+    #   @return [String]
+    # @!attribute zip
+    #   @return [String]
+    # @!attribute last_name
+    #   @return [String]
+    class PaymentRecipient
+      attr_accessor :dob,
+                    :account_number,
+                    :zip,
+                    :last_name
+    end
+  end
+end

data/lib/checkout_sdk/payments/payment_request.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute source
+    #   @return [PaymentRequestSource]
+    # @!attribute amount
+    #   @return [Integer]
+    # @!attribute currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute payment_type
+    #   @return [String] {PaymentType}
+    # @!attribute merchant_initiated
+    #   @return [TrueClass, FalseClass]
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute description
+    #   @return [String]
+    # @!attribute authorization_type
+    #   @return [String] {AuthorizationType}
+    # @!attribute capture
+    #   @return [TrueClass, FalseClass]
+    # @!attribute capture_on
+    #   @return [Time]
+    # @!attribute customer
+    #   @return [CheckoutSdk::Common::CustomerRequest]
+    # @!attribute billing_descriptor
+    #   @return [BillingDescriptor]
+    # @!attribute shipping
+    #   @return [ShippingDetails]
+    # @!attribute three_ds
+    #   @return [ThreeDSRequest]
+    # @!attribute processing_channel_id
+    #   @return [String]
+    # @!attribute previous_payment_id
+    #   @return [String]
+    # @!attribute risk
+    #   @return [RiskRequest]
+    # @!attribute success_url
+    #   @return [String]
+    # @!attribute failure_url
+    #   @return [String]
+    # @!attribute payment_ip
+    #   @return [String]
+    # @!attribute sender
+    #   @return [Sender]
+    # @!attribute recipient
+    #   @return [PaymentRecipient]
+    # @!attribute amount_allocations
+    #   @return [Array(CheckoutSdk::Common::AmountAllocations)]
+    # @!attribute processing
+    #   @return [ProcessingSettings]
+    # @!attribute metadata
+    #   @return [Hash{String => Object}]
+    # @!attribute items
+    #   @return [Array(Product)]
+    class PaymentRequest
+      attr_accessor :source,
+                    :amount,
+                    :currency,
+                    :payment_type,
+                    :merchant_initiated,
+                    :reference,
+                    :description,
+                    :authorization_type,
+                    :capture,
+                    :capture_on,
+                    :customer,
+                    :billing_descriptor,
+                    :shipping,
+                    :three_ds,
+                    :processing_channel_id,
+                    :previous_payment_id,
+                    :risk,
+                    :success_url,
+                    :failure_url,
+                    :payment_ip,
+                    :sender,
+                    :recipient,
+                    :amount_allocations,
+                    :processing,
+                    :metadata,
+                    :items
+    end
+  end
+end

data/lib/checkout_sdk/payments/payment_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module PaymentType
+      REGULAR = 'Regular'
+      RECURRING = 'Recurring'
+      MOTO = 'Moto'
+      INSTALLMENT = 'Installment'
+      UNSCHEDULED = 'Unscheduled'
+    end
+  end
+end

data/lib/checkout_sdk/payments/payments.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'checkout_sdk/payments/capture_request'
+require 'checkout_sdk/payments/passenger'
+require 'checkout_sdk/payments/authorization_request'
+require 'checkout_sdk/payments/d_local_processing_settings'
+require 'checkout_sdk/payments/payout_request'
+require 'checkout_sdk/payments/user_action'
+require 'checkout_sdk/payments/three_ds_request'
+require 'checkout_sdk/payments/product_type'
+require 'checkout_sdk/payments/payout_billing_descriptor'
+require 'checkout_sdk/payments/shipping_details'
+require 'checkout_sdk/payments/payer'
+require 'checkout_sdk/payments/authorization_type'
+require 'checkout_sdk/payments/os_type'
+require 'checkout_sdk/payments/payment_instruction'
+require 'checkout_sdk/payments/refund_request'
+require 'checkout_sdk/payments/product'
+require 'checkout_sdk/payments/source/payment_request_source'
+require 'checkout_sdk/payments/source/payout_request_source'
+require 'checkout_sdk/payments/source/network_token_source'
+require 'checkout_sdk/payments/source/token_source'
+require 'checkout_sdk/payments/source/provider_token_source'
+require 'checkout_sdk/payments/source/bank_account_source'
+require 'checkout_sdk/payments/source/payout_source_type'
+require 'checkout_sdk/payments/source/currency_account_source'
+require 'checkout_sdk/payments/source/id_source'
+require 'checkout_sdk/payments/source/card_source'
+require 'checkout_sdk/payments/source/apm/after_pay_source'
+require 'checkout_sdk/payments/source/apm/alipay_plus_source'
+require 'checkout_sdk/payments/source/apm/bancontact_source'
+require 'checkout_sdk/payments/source/apm/benefit_source'
+require 'checkout_sdk/payments/source/apm/eps_source'
+require 'checkout_sdk/payments/source/apm/giropay_source'
+require 'checkout_sdk/payments/source/apm/ideal_source'
+require 'checkout_sdk/payments/source/apm/knet_source'
+require 'checkout_sdk/payments/source/apm/mbway_source'
+require 'checkout_sdk/payments/source/apm/multi_banco_source'
+require 'checkout_sdk/payments/source/apm/p24_source'
+require 'checkout_sdk/payments/source/apm/paypal_source'
+require 'checkout_sdk/payments/source/apm/post_finance_source'
+require 'checkout_sdk/payments/source/apm/qpay_source'
+require 'checkout_sdk/payments/source/apm/sofort_source'
+require 'checkout_sdk/payments/source/apm/stcpay_source'
+require 'checkout_sdk/payments/source/apm/tamara_source'
+require 'checkout_sdk/payments/source/apm/we_chat_pay_source'
+require 'checkout_sdk/payments/sender/sender'
+require 'checkout_sdk/payments/sender/sender_type'
+require 'checkout_sdk/payments/sender/source_of_funds'
+require 'checkout_sdk/payments/sender/government_sender'
+require 'checkout_sdk/payments/sender/individual_sender'
+require 'checkout_sdk/payments/sender/corporate_sender'
+require 'checkout_sdk/payments/sender/instrument_sender'
+require 'checkout_sdk/payments/sender/ticket'
+require 'checkout_sdk/payments/capture_type'
+require 'checkout_sdk/payments/payment_type'
+require 'checkout_sdk/payments/destination/destination'
+require 'checkout_sdk/payments/destination/token_destination'
+require 'checkout_sdk/payments/destination/bank_account_destination'
+require 'checkout_sdk/payments/destination/card_destination'
+require 'checkout_sdk/payments/destination/destination_type'
+require 'checkout_sdk/payments/destination/id_destination'
+require 'checkout_sdk/payments/merchant_initiated_reason'
+require 'checkout_sdk/payments/preferred_schema'
+require 'checkout_sdk/payments/airline_data'
+require 'checkout_sdk/payments/risk_request'
+require 'checkout_sdk/payments/payments_client'
+require 'checkout_sdk/payments/billing_descriptor'
+require 'checkout_sdk/payments/payment_recipient'
+require 'checkout_sdk/payments/d_local_installments'
+require 'checkout_sdk/payments/shipping_preference'
+require 'checkout_sdk/payments/exemption'
+require 'checkout_sdk/payments/three_ds_flow_type'
+require 'checkout_sdk/payments/void_request'
+require 'checkout_sdk/payments/payment_request'
+require 'checkout_sdk/payments/passenger_name'
+require 'checkout_sdk/payments/processing_settings'
+require 'checkout_sdk/payments/charge_bearer'
+require 'checkout_sdk/payments/instruction_scheme'
+require 'checkout_sdk/payments/network_token_type'
+require 'checkout_sdk/payments/terminal_type'
+require 'checkout_sdk/payments/flight_leg_details'

data/lib/checkout_sdk/payments/payments_client.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    class PaymentsClient < Client
+      PAYMENTS_PATH = 'payments'
+      private_constant :PAYMENTS_PATH
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH
+      end
+
+      # @param [PaymentRequest] payment_request
+      # @param [String, nil] idempotency_key
+      def request_payment(payment_request, idempotency_key = nil)
+        api_client.invoke_post(PAYMENTS_PATH,
+                               sdk_authorization,
+                               payment_request,
+                               idempotency_key)
+      end
+
+      # @param [PayoutRequest] payout_request
+      # @param [String, nil] idempotency_key
+      def request_payout(payout_request, idempotency_key = nil)
+        api_client.invoke_post(PAYMENTS_PATH,
+                               sdk_authorization,
+                               payout_request,
+                               idempotency_key)
+      end
+
+      # @param [String] payment_id
+      def get_payment_details(payment_id)
+        api_client.invoke_get(build_path(PAYMENTS_PATH, payment_id),
+                              sdk_authorization)
+      end
+
+      # @param [String] payment_id
+      def get_payment_actions(payment_id)
+        api_client.invoke_get(build_path(PAYMENTS_PATH, payment_id, 'actions'),
+                              sdk_authorization)
+      end
+
+      # @param [String] payment_id
+      # @param [CaptureRequest] capture_request
+      # @param [String, nil] idempotency_key
+      def capture_payment(payment_id, capture_request = nil, idempotency_key = nil)
+        api_client.invoke_post(build_path(PAYMENTS_PATH, payment_id, 'captures'),
+                               sdk_authorization,
+                               capture_request,
+                               idempotency_key)
+      end
+
+      # @param [String] payment_id
+      # @param [RefundRequest] refund_request
+      # @param [String, nil] idempotency_key
+      def refund_payment(payment_id, refund_request = nil, idempotency_key = nil)
+        api_client.invoke_post(build_path(PAYMENTS_PATH, payment_id, 'refunds'),
+                               sdk_authorization,
+                               refund_request,
+                               idempotency_key)
+      end
+
+      # @param [String] payment_id
+      # @param [VoidRequest] void_request
+      # @param [String, nil] idempotency_key
+      def void_payment(payment_id, void_request = nil, idempotency_key = nil)
+        api_client.invoke_post(build_path(PAYMENTS_PATH, payment_id, 'voids'),
+                               sdk_authorization,
+                               void_request,
+                               idempotency_key)
+      end
+
+      # @param [String] payment_id
+      # @param [AuthorizationRequest] authorization_request
+      # @param [String, nil] idempotency_key
+      def increment_payment_authorization(payment_id, authorization_request = nil, idempotency_key = nil)
+        api_client.invoke_post(build_path(PAYMENTS_PATH, payment_id, 'authorizations'),
+                               sdk_authorization,
+                               authorization_request,
+                               idempotency_key)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/payout_billing_descriptor.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute reference
+    #   @return [String]
+    class PayoutBillingDescriptor
+      attr_accessor :reference
+    end
+  end
+end

data/lib/checkout_sdk/payments/payout_request.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute source
+    #   @return [PayoutRequestSource]
+    # @!attribute destination
+    #   @return [Destination]
+    # @!attribute amount
+    #   @return [Integer]
+    # @!attribute currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute billing_descriptor
+    #   @return [PayoutBillingDescriptor]
+    # @!attribute sender
+    #   @return [Sender]
+    # @!attribute instruction
+    #   @return [PaymentInstruction]
+    # @!attribute processing_channel_id
+    #   @return [String]
+    # @!attribute metadata
+    #   @return [Hash{String => Object}]
+    class PayoutRequest
+      attr_accessor :source,
+                    :destination,
+                    :amount,
+                    :currency,
+                    :reference,
+                    :billing_descriptor,
+                    :sender,
+                    :instruction,
+                    :processing_channel_id,
+                    :metadata
+    end
+  end
+end

data/lib/checkout_sdk/payments/preferred_schema.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module PreferredSchema
+      VISA = 'visa'
+      MASTERCARD = 'mastercard'
+      CARTES_BANCAIRES = 'cartes_bancaires'
+    end
+  end
+end

data/lib/checkout_sdk/payments/processing_settings.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute order_id
+    #   @return [String]
+    # @!attribute tax_amount
+    #   @return [Integer]
+    # @!attribute discount_amount
+    #   @return [Integer]
+    # @!attribute duty_amount
+    #   @return [Integer]
+    # @!attribute shipping_amount
+    #   @return [Integer]
+    # @!attribute shipping_tax_amount
+    #   @return [Integer]
+    # @!attribute aft
+    #   @return [TrueClass, FalseClass]
+    # @!attribute preferred_scheme
+    #   @return [String] {PreferredSchema}
+    # @!attribute merchant_initiated_reason
+    #   @return [String] {MerchantInitiatedReason}
+    # @!attribute campaign_id
+    #   @return [Integer]
+    # @!attribute product_type
+    #   @return [String] {ProductType}
+    # @!attribute open_id
+    #   @return [String]
+    # @!attribute original_order_amount
+    #   @return [Integer]
+    # @!attribute receipt_id
+    #   @return [String]
+    # @!attribute terminal_type
+    #   @return [String] {TerminalType}
+    # @!attribute os_type
+    #   @return [String] {OsType}
+    # @!attribute invoice_id
+    #   @return [String]
+    # @!attribute brand_name
+    #   @return [String]
+    # @!attribute locale
+    #   @return [String]
+    # @!attribute shipping_preference
+    #   @return [String] {ShippingPreference}
+    # @!attribute user_action
+    #   @return [String] {UserAction}
+    # @!attribute set_transaction_context
+    #   @return [Array(Hash{String => String})]
+    # @!attribute airline_data
+    #   @return [Array(AirlineData)]
+    # @!attribute dlocal
+    #   @return [DLocalProcessingSettings]
+    class ProcessingSettings
+      attr_accessor :order_id,
+                    :tax_amount,
+                    :discount_amount,
+                    :duty_amount,
+                    :shipping_amount,
+                    :shipping_tax_amount,
+                    :aft,
+                    :preferred_scheme,
+                    :merchant_initiated_reason,
+                    :campaign_id,
+                    :product_type,
+                    :open_id,
+                    :original_order_amount,
+                    :receipt_id,
+                    :terminal_type,
+                    :os_type,
+                    :invoice_id,
+                    :brand_name,
+                    :locale,
+                    :shipping_preference,
+                    :user_action,
+                    :set_transaction_context,
+                    :airline_data,
+                    :dlocal
+    end
+  end
+end

data/lib/checkout_sdk/payments/product.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute name
+    #   @return [String]
+    # @!attribute quantity
+    #   @return [Integer]
+    # @!attribute unit_price
+    #   @return [Integer]
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute commodity_code
+    #   @return [String]
+    # @!attribute unit_of_measure
+    #   @return [String]
+    # @!attribute total_amount
+    #   @return [Integer]
+    # @!attribute tax_amount
+    #   @return [Integer]
+    # @!attribute discount_amount
+    #   @return [Integer]
+    # @!attribute wxpay_goods_id
+    #   @return [String]
+    # @!attribute image_url
+    #   @return [String]
+    # @!attribute url
+    #   @return [String]
+    # @!attribute sku
+    #   @return [String]
+    class Product
+      attr_accessor :name,
+                    :quantity,
+                    :unit_price,
+                    :reference,
+                    :commodity_code,
+                    :unit_of_measure,
+                    :total_amount,
+                    :tax_amount,
+                    :discount_amount,
+                    :wxpay_goods_id,
+                    :image_url,
+                    :url,
+                    :sku
+    end
+  end
+end

data/lib/checkout_sdk/payments/product_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module ProductType
+      QR_CODE = 'QR Code'
+      IN_APP = 'In-App'
+      OFFICIAL_ACCOUNT = 'Official Account'
+      MINI_PROGRAM = 'Mini Program'
+    end
+  end
+end

data/lib/checkout_sdk/payments/refund_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute amount
+    #   @return [Integer]
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute metadata
+    #   @return [Hash{String => Object}]
+    class RefundRequest
+      attr_accessor :amount,
+                    :reference,
+                    :metadata
+    end
+  end
+end

data/lib/checkout_sdk/payments/risk_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute enabled
+    #   @return [TrueClass, FalseClass]
+    class RiskRequest
+      attr_accessor :enabled
+    end
+  end
+end

data/lib/checkout_sdk/payments/sender/corporate_sender.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute company_name
+    #   @return [String]
+    # @!attribute address
+    #   @return [String] {CheckoutSdk::Common::Address}
+    # @!attribute reference_type
+    #   @return [String]
+    # @!attribute source_of_funds
+    #   @return [String] {SourceOfFunds}
+    # @!attribute identification
+    #   @return [CheckoutSdk::Common::AccountHolderIdentification]
+    class CorporateSender < Sender
+      attr_accessor :company_name,
+                    :address,
+                    :reference_type,
+                    :source_of_funds,
+                    :identification
+
+      def initialize
+        super CheckoutSdk::Payments::SenderType::CORPORATE
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/sender/government_sender.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute company_name
+    #   @return [String]
+    # @!attribute address
+    #   @return [String] {CheckoutSdk::Common::Address}
+    # @!attribute reference_type
+    #   @return [String]
+    # @!attribute source_of_funds
+    #   @return [String] {SourceOfFunds}
+    # @!attribute identification
+    #   @return [CheckoutSdk::Common::AccountHolderIdentification]
+    class GovernmentSender < Sender
+      attr_accessor :company_name,
+                    :address,
+                    :reference_type,
+                    :source_of_funds,
+                    :identification
+
+      def initialize
+        super CheckoutSdk::Payments::SenderType::GOVERNMENT
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/sender/individual_sender.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute first_name
+    #   @return [String]
+    # @!attribute last_name
+    #   @return [String]
+    # @!attribute address
+    #   @return [String] {CheckoutSdk::Common::Address}
+    # @!attribute identification
+    #   @return [CheckoutSdk::Common::AccountHolderIdentification]
+    # @!attribute middle_name
+    #   @return [String]
+    # @!attribute reference_type
+    #   @return [String]
+    # @!attribute date_of_birth
+    #   @return [String]
+    # @!attribute source_of_funds
+    #   @return [String] {SourceOfFunds}
+    # @!attribute country_of_birth
+    #   @return [String] {CheckoutSdk::Common::Country}
+    # @!attribute nationality
+    #   @return [String] {CheckoutSdk::Common::Country}
+    class IndividualSender < Sender
+      attr_accessor :first_name,
+                    :last_name,
+                    :address,
+                    :identification,
+                    :middle_name,
+                    :reference_type,
+                    :date_of_birth,
+                    :source_of_funds,
+                    :country_of_birth,
+                    :nationality
+
+      def initialize
+        super CheckoutSdk::Payments::SenderType::INDIVIDUAL
+      end
+    end
+  end
+end