bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/charge_plus_optin_request.rb

@@ -0,0 +1,390 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'charge-plus-optin' Request - General Parameters
+  class ChargePlusOptinRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of charge
+    # @return [String]
+    attr_reader :charge_type
+
+    # ISO 3166-1 alpha-2 country code.
+    # @return [String]
+    attr_accessor :country
+
+    # ISO 4217 three-letter currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # ISO 4217 three-letter currency code.
+    # @return [ChargePlusOptinRequestHosted]
+    attr_accessor :hosted
+
+    # Unique identifier for the consumer, assigned by the merchant.
+    # @return [String]
+    attr_accessor :merchant_consumer_id
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # A description of the purchased item.
+    # @return [String]
+    attr_accessor :merchant_item_description
+
+    # Merchant-assigned unique request ID.
+    # Multiple requests received with the same merchant-request-id will be
+    # handled idempotently within the idempotency window.
+    # @return [String]
+    attr_accessor :merchant_request_id
+
+    # Merchant-assigned transaction ID.
+    # _***Boku recommends merchants send this ID for future reference.**_
+    # @return [String]
+    attr_accessor :merchant_transaction_id
+
+    # Supplies the URL for Boku to send a notification once the charge is
+    # complete.
+    # @return [String]
+    attr_accessor :notification_url
+
+    # The payment method selected by the consumer.
+    # Each wallet provider will be its own payment method. A list of available
+    # values will be provided on demand.
+    # @return [String]
+    attr_accessor :payment_method
+
+    # Total amount to charge, including tax.
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # The Boku Bank ID selected by the consumer.
+    # _***Note: This field is required only for specific payment issuers. Please
+    # contact your Integration Manager to confirm whether it's needed for your
+    # integration.**_
+    # @return [String]
+    attr_accessor :bank_id
+
+    # The IP address of the consumer. Helps improve fraud detection by
+    # supporting internal risk checks and partner decisions. Supports IPv4 and
+    # IPv6 formats.
+    # @return [String]
+    attr_accessor :consumer_ip_address
+
+    # The IP address of the consumer. Helps improve fraud detection by
+    # supporting internal risk checks and partner decisions. Supports IPv4 and
+    # IPv6 formats.
+    # @return [Hash[String, String]]
+    attr_accessor :consumer_transaction_data
+
+    # Merchant-supplied metadata. This metadata is returned in the
+    # 'charge-plus-optin' response and can be available in merchant reports.
+    # @return [String]
+    attr_accessor :merchant_data
+
+    # Merchant-assigned unique opt-in ID.
+    # @return [String]
+    attr_accessor :merchant_optin_id
+
+    # Content defining the specific terms and conditions associated with this
+    # opt-in. This may include pricing details or user consent requirements
+    # presented to the end user during the opt-in flow.
+    # @return [OptinTerms]
+    attr_accessor :optin_terms
+
+    # Optin and Charge Request API can be made for specific Seller of Record
+    # previously registered with Boku.
+    # @return [SellerOfRecord]
+    attr_accessor :seller_of_record
+
+    # Optin and Charge Request API can be made for specific Seller of Record
+    # previously registered with Boku.
+    # @return [String]
+    attr_accessor :source_country
+
+    # Specifies how long to block waiting for a response
+    # @return [Timeout]
+    attr_accessor :timeout
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['charge_type'] = 'charge-type'
+      @_hash['country'] = 'country'
+      @_hash['currency'] = 'currency'
+      @_hash['hosted'] = 'hosted'
+      @_hash['merchant_consumer_id'] = 'merchant-consumer-id'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_item_description'] = 'merchant-item-description'
+      @_hash['merchant_request_id'] = 'merchant-request-id'
+      @_hash['merchant_transaction_id'] = 'merchant-transaction-id'
+      @_hash['notification_url'] = 'notification-url'
+      @_hash['payment_method'] = 'payment-method'
+      @_hash['total_amount'] = 'total-amount'
+      @_hash['bank_id'] = 'bank-id'
+      @_hash['consumer_ip_address'] = 'consumer-ip-address'
+      @_hash['consumer_transaction_data'] = 'consumer-transaction-data'
+      @_hash['merchant_data'] = 'merchant-data'
+      @_hash['merchant_optin_id'] = 'merchant-optin-id'
+      @_hash['optin_terms'] = 'optin-terms'
+      @_hash['seller_of_record'] = 'seller-of-record'
+      @_hash['source_country'] = 'source-country'
+      @_hash['timeout'] = 'timeout'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bank_id
+        consumer_ip_address
+        consumer_transaction_data
+        merchant_data
+        merchant_optin_id
+        optin_terms
+        seller_of_record
+        source_country
+        timeout
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, currency = nil, hosted = nil,
+                   merchant_consumer_id = nil, merchant_id = nil,
+                   merchant_item_description = nil, merchant_request_id = nil,
+                   merchant_transaction_id = nil, notification_url = nil,
+                   payment_method = nil, total_amount = nil, bank_id = SKIP,
+                   consumer_ip_address = SKIP, consumer_transaction_data = SKIP,
+                   merchant_data = SKIP, merchant_optin_id = SKIP,
+                   optin_terms = SKIP, seller_of_record = SKIP,
+                   source_country = SKIP, timeout = SKIP)
+      @charge_type = 'hosted'
+      @country = country
+      @currency = currency
+      @hosted = hosted
+      @merchant_consumer_id = merchant_consumer_id
+      @merchant_id = merchant_id
+      @merchant_item_description = merchant_item_description
+      @merchant_request_id = merchant_request_id
+      @merchant_transaction_id = merchant_transaction_id
+      @notification_url = notification_url
+      @payment_method = payment_method
+      @total_amount = total_amount
+      @bank_id = bank_id unless bank_id == SKIP
+      @consumer_ip_address = consumer_ip_address unless consumer_ip_address == SKIP
+      unless consumer_transaction_data == SKIP
+        @consumer_transaction_data =
+          consumer_transaction_data
+      end
+      @merchant_data = merchant_data unless merchant_data == SKIP
+      @merchant_optin_id = merchant_optin_id unless merchant_optin_id == SKIP
+      @optin_terms = optin_terms unless optin_terms == SKIP
+      @seller_of_record = seller_of_record unless seller_of_record == SKIP
+      @source_country = source_country unless source_country == SKIP
+      @timeout = timeout unless timeout == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      country = hash.key?('country') ? hash['country'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      hosted = ChargePlusOptinRequestHosted.from_hash(hash['hosted']) if hash['hosted']
+      merchant_consumer_id =
+        hash.key?('merchant-consumer-id') ? hash['merchant-consumer-id'] : nil
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_item_description =
+        hash.key?('merchant-item-description') ? hash['merchant-item-description'] : nil
+      merchant_request_id =
+        hash.key?('merchant-request-id') ? hash['merchant-request-id'] : nil
+      merchant_transaction_id =
+        hash.key?('merchant-transaction-id') ? hash['merchant-transaction-id'] : nil
+      notification_url =
+        hash.key?('notification-url') ? hash['notification-url'] : nil
+      payment_method =
+        hash.key?('payment-method') ? hash['payment-method'] : nil
+      total_amount = hash.key?('total-amount') ? hash['total-amount'] : nil
+      bank_id = hash.key?('bank-id') ? hash['bank-id'] : SKIP
+      consumer_ip_address =
+        hash.key?('consumer-ip-address') ? hash['consumer-ip-address'] : SKIP
+      consumer_transaction_data =
+        hash.key?('consumer-transaction-data') ? hash['consumer-transaction-data'] : SKIP
+      merchant_data = hash.key?('merchant-data') ? hash['merchant-data'] : SKIP
+      merchant_optin_id =
+        hash.key?('merchant-optin-id') ? hash['merchant-optin-id'] : SKIP
+      optin_terms = OptinTerms.from_hash(hash['optin-terms']) if hash['optin-terms']
+      seller_of_record = SellerOfRecord.from_hash(hash['seller-of-record']) if
+        hash['seller-of-record']
+      source_country =
+        hash.key?('source-country') ? hash['source-country'] : SKIP
+      timeout = Timeout.from_hash(hash['timeout']) if hash['timeout']
+
+      # Create object from extracted values.
+      ChargePlusOptinRequest.new(country,
+                                 currency,
+                                 hosted,
+                                 merchant_consumer_id,
+                                 merchant_id,
+                                 merchant_item_description,
+                                 merchant_request_id,
+                                 merchant_transaction_id,
+                                 notification_url,
+                                 payment_method,
+                                 total_amount,
+                                 bank_id,
+                                 consumer_ip_address,
+                                 consumer_transaction_data,
+                                 merchant_data,
+                                 merchant_optin_id,
+                                 optin_terms,
+                                 seller_of_record,
+                                 source_country,
+                                 timeout)
+    end
+
+    def self.from_element(root)
+      charge_type = XmlUtilities.from_element(root, 'charge-type', String)
+      country = XmlUtilities.from_element(root, 'country', String)
+      currency = XmlUtilities.from_element(root, 'currency', String)
+      hosted = XmlUtilities.from_element(root, 'hosted',
+                                         ChargePlusOptinRequestHosted)
+      merchant_consumer_id = XmlUtilities.from_element(root,
+                                                       'merchant-consumer-id',
+                                                       String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_item_description = XmlUtilities.from_element(
+        root, 'merchant-item-description', String
+      )
+      merchant_request_id = XmlUtilities.from_element(root,
+                                                      'merchant-request-id',
+                                                      String)
+      merchant_transaction_id = XmlUtilities.from_element(
+        root, 'merchant-transaction-id', String
+      )
+      notification_url = XmlUtilities.from_element(root, 'notification-url',
+                                                   String)
+      payment_method = XmlUtilities.from_element(root, 'payment-method', String)
+      total_amount = XmlUtilities.from_element(root, 'total-amount', Float)
+      bank_id = XmlUtilities.from_element(root, 'bank-id', String)
+      consumer_ip_address = XmlUtilities.from_element(root,
+                                                      'consumer-ip-address',
+                                                      String)
+      consumer_transaction_data = XmlUtilities.from_element_to_hash(
+        root, 'consumer-transaction-data', Hash
+      )
+      merchant_data = XmlUtilities.from_element(root, 'merchant-data', String)
+      merchant_optin_id = XmlUtilities.from_element(root, 'merchant-optin-id',
+                                                    String)
+      optin_terms = XmlUtilities.from_element(root, 'terms', OptinTerms)
+      seller_of_record = XmlUtilities.from_element(root, 'seller-of-record',
+                                                   SellerOfRecord)
+      source_country = XmlUtilities.from_element(root, 'source-country', String)
+      timeout = XmlUtilities.from_element(root, 'timeout', Timeout)
+
+      new(charge_type,
+          country,
+          currency,
+          hosted,
+          merchant_consumer_id,
+          merchant_id,
+          merchant_item_description,
+          merchant_request_id,
+          merchant_transaction_id,
+          notification_url,
+          payment_method,
+          total_amount,
+          bank_id,
+          consumer_ip_address,
+          consumer_transaction_data,
+          merchant_data,
+          merchant_optin_id,
+          optin_terms,
+          seller_of_record,
+          source_country,
+          timeout)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'charge-type', charge_type)
+      XmlUtilities.add_as_subelement(doc, root, 'country', country)
+      XmlUtilities.add_as_subelement(doc, root, 'currency', currency)
+      XmlUtilities.add_as_subelement(doc, root, 'hosted', hosted)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-consumer-id',
+                                     merchant_consumer_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-item-description',
+                                     merchant_item_description)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-request-id',
+                                     merchant_request_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-transaction-id',
+                                     merchant_transaction_id)
+      XmlUtilities.add_as_subelement(doc, root, 'notification-url',
+                                     notification_url)
+      XmlUtilities.add_as_subelement(doc, root, 'payment-method',
+                                     payment_method)
+      XmlUtilities.add_as_subelement(doc, root, 'total-amount', total_amount)
+      XmlUtilities.add_as_subelement(doc, root, 'bank-id', bank_id)
+      XmlUtilities.add_as_subelement(doc, root, 'consumer-ip-address',
+                                     consumer_ip_address)
+      XmlUtilities.add_hash_as_subelement(doc, root,
+                                          'consumer-transaction-data',
+                                          consumer_transaction_data)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-data', merchant_data)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-optin-id',
+                                     merchant_optin_id)
+      XmlUtilities.add_as_subelement(doc, root, 'terms', optin_terms)
+      XmlUtilities.add_as_subelement(doc, root, 'seller-of-record',
+                                     seller_of_record)
+      XmlUtilities.add_as_subelement(doc, root, 'source-country',
+                                     source_country)
+      XmlUtilities.add_as_subelement(doc, root, 'timeout', timeout)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} charge_type: #{@charge_type}, country: #{@country}, currency: #{@currency},"\
+      " hosted: #{@hosted}, merchant_consumer_id: #{@merchant_consumer_id}, merchant_id:"\
+      " #{@merchant_id}, merchant_item_description: #{@merchant_item_description},"\
+      " merchant_request_id: #{@merchant_request_id}, merchant_transaction_id:"\
+      " #{@merchant_transaction_id}, notification_url: #{@notification_url}, payment_method:"\
+      " #{@payment_method}, total_amount: #{@total_amount}, bank_id: #{@bank_id},"\
+      " consumer_ip_address: #{@consumer_ip_address}, consumer_transaction_data:"\
+      " #{@consumer_transaction_data}, merchant_data: #{@merchant_data}, merchant_optin_id:"\
+      " #{@merchant_optin_id}, optin_terms: #{@optin_terms}, seller_of_record:"\
+      " #{@seller_of_record}, source_country: #{@source_country}, timeout: #{@timeout}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} charge_type: #{@charge_type.inspect}, country: #{@country.inspect},"\
+      " currency: #{@currency.inspect}, hosted: #{@hosted.inspect}, merchant_consumer_id:"\
+      " #{@merchant_consumer_id.inspect}, merchant_id: #{@merchant_id.inspect},"\
+      " merchant_item_description: #{@merchant_item_description.inspect}, merchant_request_id:"\
+      " #{@merchant_request_id.inspect}, merchant_transaction_id:"\
+      " #{@merchant_transaction_id.inspect}, notification_url: #{@notification_url.inspect},"\
+      " payment_method: #{@payment_method.inspect}, total_amount: #{@total_amount.inspect},"\
+      " bank_id: #{@bank_id.inspect}, consumer_ip_address: #{@consumer_ip_address.inspect},"\
+      " consumer_transaction_data: #{@consumer_transaction_data.inspect}, merchant_data:"\
+      " #{@merchant_data.inspect}, merchant_optin_id: #{@merchant_optin_id.inspect}, optin_terms:"\
+      " #{@optin_terms.inspect}, seller_of_record: #{@seller_of_record.inspect}, source_country:"\
+      " #{@source_country.inspect}, timeout: #{@timeout.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/charge_plus_optin_request_hosted.rb

@@ -0,0 +1,96 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # ChargePlusOptinRequestHosted Model.
+  class ChargePlusOptinRequestHosted < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Supplies the URL for Boku to redirect the consumer back to the merchant UI
+    # to complete authentication.
+    # @return [String]
+    attr_accessor :forward_url
+
+    # True if a mobile-optimized purchase flow should be used for this request,
+    # false otherwise.
+    # Example: A non-mobile-optimized flow could display a QR code on the user's
+    # mobile. The user would be unable to scan the QR code because they are
+    # already on their mobile.
+    # A mobile-optimized flow could display a mobile login page to the user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_mobile_flow
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['forward_url'] = 'forward-url'
+      @_hash['use_mobile_flow'] = 'use-mobile-flow'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        use_mobile_flow
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(forward_url = nil, use_mobile_flow = false)
+      @forward_url = forward_url
+      @use_mobile_flow = use_mobile_flow unless use_mobile_flow == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      forward_url = hash.key?('forward-url') ? hash['forward-url'] : nil
+      use_mobile_flow = hash['use-mobile-flow'] ||= false
+
+      # Create object from extracted values.
+      ChargePlusOptinRequestHosted.new(forward_url,
+                                       use_mobile_flow)
+    end
+
+    def self.from_element(root)
+      forward_url = XmlUtilities.from_element(root, 'forward-url', String)
+      use_mobile_flow = XmlUtilities.from_element(root, 'use-mobile-flow',
+                                                  TrueClass)
+
+      new(forward_url,
+          use_mobile_flow)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'forward-url', forward_url)
+      XmlUtilities.add_as_subelement(doc, root, 'use-mobile-flow',
+                                     use_mobile_flow)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} forward_url: #{@forward_url}, use_mobile_flow: #{@use_mobile_flow}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} forward_url: #{@forward_url.inspect}, use_mobile_flow:"\
+      " #{@use_mobile_flow.inspect}>"
+    end
+  end
+end