checkout_sdk 1.2.2 → 1.9.1

data/lib/checkout_sdk/payments/destination/id_destination.rb

@@ -11,7 +11,7 @@ module CheckoutSdk
                     :account_holder
 
       def initialize
-        super CheckoutSdk::Payments::DestinationType::ID
+        super(CheckoutSdk::Payments::DestinationType::ID)
       end
     end
   end

data/lib/checkout_sdk/payments/destination/token_destination.rb

@@ -11,7 +11,7 @@ module CheckoutSdk
                     :account_holder
 
       def initialize
-        super CheckoutSdk::Payments::DestinationType::TOKEN
+        super(CheckoutSdk::Payments::DestinationType::TOKEN)
       end
     end
   end

data/lib/checkout_sdk/payments/exemption.rb

@@ -12,6 +12,8 @@ module CheckoutSdk
       OUT_OF_SCA_SCOPE = 'out_of_sca_scope'
       OTHER = 'other'
       LOW_RISK_PROGRAM = 'low_risk_program'
+      DATA_SHARE = 'data_share'
+      RECURRING_OPERATION = 'recurring_operation'
     end
   end
 end

data/lib/checkout_sdk/payments/flow/flow_client.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Client for Payment Flow API operations
+    # [Beta]
+    class FlowClient < Client
+      PAYMENT_SESSIONS_PATH = 'payment-sessions'
+      SUBMIT_PATH = 'submit'
+      COMPLETE_PATH = 'complete'
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
+      end
+
+      # Creates a Payment Session.
+      # Use this endpoint to set up a payment session before collecting payment details from your customer.
+      # [Beta]
+      #
+      # @param [Hash] request_payment_session_request
+      def request_payment_session(request_payment_session_request)
+        api_client.invoke_post(
+          build_path(PAYMENT_SESSIONS_PATH),
+          sdk_authorization,
+          request_payment_session_request
+        )
+      end
+
+      # Submits a Payment Session.
+      # Use this endpoint to submit payment details and process the payment for an existing session.
+      # [Beta]
+      #
+      # @param [String] id - The unique identifier of the Payment Session
+      # @param [Hash] submit_payment_session_request
+      def submit_payment_session(id, submit_payment_session_request)
+        api_client.invoke_post(
+          build_path(PAYMENT_SESSIONS_PATH, id, SUBMIT_PATH),
+          sdk_authorization,
+          submit_payment_session_request
+        )
+      end
+
+      # Creates and submits a Payment Session in a single request.
+      # Use this endpoint to create a payment session and immediately process the payment.
+      # [Beta]
+      #
+      # @param [Hash] request_payment_session_with_payment_request
+      def request_payment_session_with_payment(request_payment_session_with_payment_request)
+        api_client.invoke_post(
+          build_path(PAYMENT_SESSIONS_PATH, COMPLETE_PATH),
+          sdk_authorization,
+          request_payment_session_with_payment_request
+        )
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/google_pay/google_pay_client.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Client for the Google Pay endpoints. All endpoints require OAuth.
+    class GooglePayClient < Client
+      GOOGLEPAY = 'googlepay'
+      ENROLLMENTS = 'enrollments'
+      DOMAIN = 'domain'
+      DOMAINS = 'domains'
+      STATE = 'state'
+      private_constant :GOOGLEPAY, :ENROLLMENTS, :DOMAIN, :DOMAINS, :STATE
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::OAUTH)
+      end
+
+      # @param [Hash, GooglePayEnrollmentRequest] enrollment_request
+      def enroll_entity(enrollment_request)
+        api_client.invoke_post(build_path(GOOGLEPAY, ENROLLMENTS),
+                               sdk_authorization,
+                               enrollment_request)
+      end
+
+      # @param [String] entity_id
+      # @param [Hash, GooglePayDomainRequest] domain_request
+      def register_domain(entity_id, domain_request)
+        api_client.invoke_post(build_path(GOOGLEPAY, ENROLLMENTS, entity_id, DOMAIN),
+                               sdk_authorization,
+                               domain_request)
+      end
+
+      # @param [String] entity_id
+      def get_registered_domains(entity_id)
+        api_client.invoke_get(build_path(GOOGLEPAY, ENROLLMENTS, entity_id, DOMAINS),
+                              sdk_authorization)
+      end
+
+      # @param [String] entity_id
+      def get_enrollment_state(entity_id)
+        api_client.invoke_get(build_path(GOOGLEPAY, ENROLLMENTS, entity_id, STATE),
+                              sdk_authorization)
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/google_pay/google_pay_domain_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Request body for POST /googlepay/enrollments/{entity_id}/domain.
+    #
+    # @!attribute web_domain
+    #   @return [String] Web domain to register for the enrolled entity.
+    class GooglePayDomainRequest
+      attr_accessor :web_domain
+    end
+  end
+end

data/lib/checkout_sdk/payments/google_pay/google_pay_enrollment_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Request body for POST /googlepay/enrollments.
+    #
+    # @!attribute entity_id
+    #   @return [String] Entity to enroll.
+    # @!attribute email_address
+    #   @return [String]
+    # @!attribute accept_terms_of_service
+    #   @return [Boolean]
+    class GooglePayEnrollmentRequest
+      attr_accessor :entity_id, :email_address, :accept_terms_of_service
+    end
+  end
+end

data/lib/checkout_sdk/payments/googlepay.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    # @!attribute store_payment_details
+    #   @return [String] {StorePaymentDetailsType}
+    class Googlepay
+      attr_accessor :account_holder,
+                    :store_payment_details
+    end
+  end
+end

data/lib/checkout_sdk/payments/hosted/hosted_payment_instruction.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute purpose
+    #   @return [String] {PaymentPurposeType}
+    class HostedPaymentInstruction
+      attr_accessor :purpose
+    end
+  end
+end

data/lib/checkout_sdk/payments/hosted/hosted_payments_client.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       # @param [ApiClient] api_client
       # @param [CheckoutConfiguration] configuration
       def initialize(api_client, configuration)
-        super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY)
       end
 
       # @param [Hash, HostedPaymentsSession] hosted_payments_session

data/lib/checkout_sdk/payments/hosted/hosted_payments_session.rb

@@ -1,11 +1,21 @@
 # frozen_string_literal: true
 
+require 'checkout_sdk/payments/payment_type'
+
 module CheckoutSdk
   module Payments
-    # @!attribute amount
-    #   @return [Integer]
     # @!attribute currency
     #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute billing
+    #   @return [BillingInformation]
+    # @!attribute success_url
+    #   @return [String]
+    # @!attribute cancel_url
+    #   @return [String]
+    # @!attribute failure_url
+    #   @return [String]
+    # @!attribute amount
+    #   @return [Integer]
     # @!attribute payment_type
     #   @return [String] {PaymentType}
     # @!attribute payment_ip
@@ -16,12 +26,16 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute description
     #   @return [String]
+    # @!attribute display_name
+    #   @return [String]
+    # @!attribute processing_channel_id
+    #   @return [String]
+    # @!attribute amount_allocations
+    #   @return [Array(CheckoutSdk::Common::AmountAllocations)]
     # @!attribute customer
     #   @return [CheckoutSdk::Common::CustomerRequest]
     # @!attribute shipping
     #   @return [ShippingDetails]
-    # @!attribute billing
-    #   @return [BillingInformation]
     # @!attribute recipient
     #   @return [PaymentRecipient]
     # @!attribute processing
@@ -34,53 +48,67 @@ module CheckoutSdk
     #   @return [Array(CheckoutSdk::Common::Product)]
     # @!attribute risk
     #   @return [RiskRequest]
-    # @!attribute success_url
-    #   @return [String]
-    # @!attribute cancel_url
-    #   @return [String]
-    # @!attribute failure_url
-    #   @return [String]
+    # @!attribute customer_retry
+    #   @return [PaymentRetryRequest]
+    # @!attribute sender
+    #   @return [CheckoutSdk::Payments::Sender]
     # @!attribute metadata
     #   @return [Hash(String=>Object)]
     # @!attribute locale
-    #   @return [String]
+    #   @return [String] {LocaleType}
     # @!attribute three_ds
     #   @return [ThreeDSRequest]
     # @!attribute capture
     #   @return [TrueClass, FalseClass]
     # @!attribute capture_on
     #   @return [Time]
-    # @!attribute processing_channel_id
-    #   @return [String] - Not available on Previous.
-    # @!attribute amount_allocations
-    #   @return [Array(CheckoutSdk::Common::AmountAllocations)] - Not available on Previous.
+    # @!attribute instruction
+    #   @return [HostedPaymentInstruction]
+    # @!attribute payment_method_configuration
+    #   @return [PaymentMethodConfiguration]
+    # @!attribute payment_plan
+    #   @return [PaymentPlan] [Optional] The information to process a recurring payment request.
+    #     To be used when the payment_type is Recurring.
+    # @!attribute authorization_type
+    #   @return [String] [Optional] {AuthorizationType} Enum: "Final" "Estimated". Default: "Final".
     class HostedPaymentsSession
-      attr_accessor :amount,
-                    :currency,
+      attr_accessor :currency,
+                    :billing,
+                    :success_url,
+                    :cancel_url,
+                    :failure_url,
+                    :amount,
                     :payment_type,
                     :payment_ip,
                     :billing_descriptor,
                     :reference,
                     :description,
+                    :display_name,
+                    :processing_channel_id,
+                    :amount_allocations,
                     :customer,
                     :shipping,
-                    :billing,
                     :recipient,
                     :processing,
                     :allow_payment_methods,
                     :disabled_payment_methods,
                     :products,
                     :risk,
-                    :success_url,
-                    :cancel_url,
-                    :failure_url,
+                    :customer_retry,
+                    :sender,
                     :metadata,
                     :locale,
                     :three_ds,
                     :capture,
                     :capture_on,
-                    :processing_channel_id,
-                    :amount_allocations
+                    :instruction,
+                    :payment_method_configuration,
+                    :payment_plan,
+                    :authorization_type
+
+      def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
+        @payment_type = payment_type
+      end
     end
   end
 end

data/lib/checkout_sdk/payments/hosted/payment_purpose_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    class PaymentPurposeType
+      DONATIONS = 'donations'
+      EDUCATION = 'education'
+      EMERGENCY_NEED = 'emergency_need'
+      EXPATRIATION = 'expatriation'
+      FAMILY_SUPPORT = 'family_support'
+      FINANCIAL_SERVICES = 'financial_services'
+      GIFTS = 'gifts'
+      INCOME = 'income'
+      INSURANCE = 'insurance'
+      INVESTMENT = 'investment'
+      IT_SERVICES = 'it_services'
+      LEISURE = 'leisure'
+      LOAN_PAYMENT = 'loan_payment'
+      MEDICAL_TREATMENT = 'medical_treatment'
+      OTHER = 'other'
+      PENSION = 'pension'
+      ROYALTIES = 'royalties'
+      SAVINGS = 'savings'
+      TRAVEL_AND_TOURISM = 'travel_and_tourism'
+    end
+  end
+end

data/lib/checkout_sdk/payments/links/payment_link.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'checkout_sdk/payments/payment_type'
+
 module CheckoutSdk
   module Payments
     # @!attribute amount
@@ -16,6 +18,8 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute description
     #   @return [String]
+    # @!attribute display_name
+    #   @return [String]
     # @!attribute processing_channel_id
     #   @return [String] - Not available on Previous.
     # @!attribute amount_allocations
@@ -34,6 +38,8 @@ module CheckoutSdk
     #   @return [ProcessingSettings]
     # @!attribute allow_payment_methods
     #   @return [Array(CheckoutSdk::Common::PaymentSourceType)]
+    # @!attribute disabled_payment_methods
+    #   @return [Array(CheckoutSdk::Common::PaymentSourceType)]
     # @!attribute products
     #   @return [Array(CheckoutSdk::Common::Product)]
     # @!attribute metadata
@@ -42,6 +48,10 @@ module CheckoutSdk
     #   @return [ThreeDSRequest]
     # @!attribute risk
     #   @return [RiskRequest]
+    # @!attribute customer_retry
+    #   @return [CheckoutSdk::Common::CustomerRetry]
+    # @!attribute sender
+    #   @return [CheckoutSdk::Payments::Sender]
     # @!attribute return_url
     #   @return [String]
     # @!attribute locale
@@ -50,6 +60,11 @@ module CheckoutSdk
     #   @return [TrueClass, FalseClass]
     # @!attribute capture_on
     #   @return [Time]
+    # @!attribute payment_plan
+    #   @return [PaymentPlan] [Optional] The information to process a recurring payment request.
+    #     To be used when the payment_type is Recurring.
+    # @!attribute authorization_type
+    #   @return [String] [Optional] {AuthorizationType} Enum: "Final" "Estimated". Default: "Final".
     class PaymentLink
       attr_accessor :amount,
                     :currency,
@@ -58,6 +73,7 @@ module CheckoutSdk
                     :billing_descriptor,
                     :reference,
                     :description,
+                    :display_name,
                     :processing_channel_id,
                     :amount_allocations,
                     :expires_in,
@@ -67,14 +83,23 @@ module CheckoutSdk
                     :recipient,
                     :processing,
                     :allow_payment_methods,
+                    :disabled_payment_methods,
                     :products,
                     :metadata,
                     :three_ds,
                     :risk,
+                    :customer_retry,
+                    :sender,
                     :return_url,
                     :locale,
                     :capture,
-                    :capture_on
+                    :capture_on,
+                    :payment_plan,
+                    :authorization_type
+
+      def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
+        @payment_type = payment_type
+      end
     end
   end
 end

data/lib/checkout_sdk/payments/links/payments_links_client.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       # @param [ApiClient] api_client
       # @param [CheckoutConfiguration] configuration
       def initialize(api_client, configuration)
-        super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY)
       end
 
       # @param [Hash, PaymentLink] payment_link

data/lib/checkout_sdk/payments/locale_type.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module LocaleType
+      AR = 'ar'
+      DA_DK = 'da-DK'
+      DE_DE = 'de-DE'
+      EL = 'el'
+      EN_GB = 'en-GB'
+      ES_ES = 'es-ES'
+      FI_FI = 'fi-FI'
+      FIL_PH = 'fil-PH'
+      FR_FR = 'fr-FR'
+      HI_IN = 'hi-IN'
+      ID_ID = 'id-ID'
+      IT_IT = 'it-IT'
+      JA_JP = 'ja-JP'
+      MS_MY = 'ms-MY'
+      NB_NO = 'nb-NO'
+      NL_NL = 'nl-NL'
+      PT_PT = 'pt-PT'
+      SV_SE = 'sv-SE'
+      TH_TH = 'th-TH'
+      VI_VN = 'vi-VN'
+      ZH_CN = 'zh-CN'
+      ZH_HK = 'zh-HK'
+      ZH_TW = 'zh-TW'
+    end
+  end
+end

data/lib/checkout_sdk/payments/partial_authorization.rb

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

data/lib/checkout_sdk/payments/passenger.rb

@@ -2,16 +2,30 @@
 
 module CheckoutSdk
   module Payments
-    # @!attribute name
+    # Contains information about a passenger on the flight
+    # (PaymentInterfacesProcessingAirlinePassengerData).
+    #
+    # @!attribute first_name
     #   @return [String]
-    # @!attribute date_of_birth
+    # @!attribute last_name
     #   @return [String]
-    # @!attribute country_code
-    #   @return [String] {CheckoutSdk::Common::Country}
+    # @!attribute date_of_birth
+    #   @return [String] Format: YYYY-MM-DD
+    # @!attribute address
+    #   @return [PassengerAddress]
     class Passenger
-      attr_accessor :name,
+      attr_accessor :first_name,
+                    :last_name,
                     :date_of_birth,
-                    :country_code
+                    :address
+    end
+
+    # Partial address information for an airline passenger.
+    #
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country}
+    class PassengerAddress
+      attr_accessor :country
     end
   end
 end

data/lib/checkout_sdk/payments/payment_method_configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute applepay
+    #   @return [Applepay]
+    # @!attribute card
+    #   @return [Card]
+    # @!attribute googlepay
+    #   @return [Googlepay]
+    class PaymentMethodConfiguration
+      attr_accessor :applepay,
+                    :card,
+                    :googlepay
+    end
+  end
+end

data/lib/checkout_sdk/payments/payment_plan.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # Details of a recurring subscription or installment plan associated with a payment.
+    #
+    # @!attribute amount_variability
+    #   @return [String] Recurring-only. One of "Fixed" or "Variable".
+    # @!attribute financing
+    #   @return [TrueClass, FalseClass] Installment-only.
+    # @!attribute amount
+    #   @return [Integer] The amount to charge for each payment in the plan, in the minor currency unit.
+    #     Required when source.type is "blik", amount_variability is "Fixed", and the recurring
+    #     agreement is created without an initial payment (amount set to 0).
+    # @!attribute days_between_payments
+    #   @return [Integer]
+    # @!attribute total_number_of_payments
+    #   @return [Integer]
+    # @!attribute current_payment_number
+    #   @return [Integer]
+    # @!attribute expiry
+    #   @return [String] ISO 8601 date-time
+    # @!attribute name
+    #   @return [String] The name of the payment plan. Required when source.type is "blik".
+    #     For Blik merchant-initiated requests using an external partner_agreement_id, this value
+    #     is used as the Blik Alias Label. Max 35 characters.
+    # @!attribute start_date
+    #   @return [String] The date on which the first payment will be taken, in YYYYMMDD format.
+    #     Required when source.type is "blik" and the recurring agreement is created without an
+    #     initial payment (amount set to 0).
+    class PaymentPlan
+      attr_accessor :amount_variability,
+                    :financing,
+                    :amount,
+                    :days_between_payments,
+                    :total_number_of_payments,
+                    :current_payment_number,
+                    :expiry,
+                    :name,
+                    :start_date
+    end
+  end
+end

data/lib/checkout_sdk/payments/payment_request.rb

@@ -18,6 +18,8 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute description
     #   @return [String]
+    # @!attribute partial_authorization
+    #   @return [PartialAuthorization]
     # @!attribute authorization_type
     #   @return [String] {AuthorizationType}
     # @!attribute capture
@@ -74,6 +76,7 @@ module CheckoutSdk
                     :merchant_initiated,
                     :reference,
                     :description,
+                    :partial_authorization,
                     :authorization_type,
                     :capture,
                     :capture_on,
@@ -96,7 +99,8 @@ module CheckoutSdk
                     :items,
                     :retry,
                     :metadata,
-                    :instruction
+                    :instruction,
+                    :fallback_source
     end
   end
 end