bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/refund_charge_response.rb

@@ -0,0 +1,203 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'refund-charge' Response - General Elements
+  class RefundChargeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the charge being refunded
+    # @return [String]
+    attr_accessor :charge_id
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Merchant-assigned request ID.
+    # @return [String]
+    attr_accessor :merchant_request_id
+
+    # The 'result' element is defined in every response type. It is used to
+    # convey the outcome of an API request.
+    # @return [Result]
+    attr_accessor :result
+
+    # ISO 3166-1 alpha-2 country code.
+    # @return [String]
+    attr_accessor :country
+
+    # Issuer's Network ID.
+    # @return [String]
+    attr_accessor :network_id
+
+    # Boku-assigned refund ID
+    # If null, no refund was created, e.g. because the request was rejected.
+    # @return [String]
+    attr_accessor :refund_id
+
+    # Status of the refund at the time this response was returned.
+    # If 'in-progress' is returned, the refund call should be re-issued with the
+    # same request ID until a final status is reached.
+    # If null, no refund was created, e.g. because the request was rejected.
+    # @return [RefundStatusEnum]
+    attr_accessor :refund_status
+
+    # **DISCLAIMER: This API or element is use-case specific and not needed for
+    # generic usage of our payment product. Please disregard unless otherwise
+    # directed to include in your integration.**
+    # Element containing settlement information about the original charge.
+    # @return [Settlement]
+    attr_accessor :settlement
+
+    # Time request was received ("YYYY-MM-DD hh:mm:ss").
+    # All timestamps are in UTC.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['charge_id'] = 'charge-id'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_request_id'] = 'merchant-request-id'
+      @_hash['result'] = 'result'
+      @_hash['country'] = 'country'
+      @_hash['network_id'] = 'network-id'
+      @_hash['refund_id'] = 'refund-id'
+      @_hash['refund_status'] = 'refund-status'
+      @_hash['settlement'] = 'settlement'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country
+        network_id
+        refund_id
+        refund_status
+        settlement
+        timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(charge_id = nil, merchant_id = nil,
+                   merchant_request_id = nil, result = nil, country = SKIP,
+                   network_id = SKIP, refund_id = SKIP, refund_status = SKIP,
+                   settlement = SKIP, timestamp = SKIP)
+      @charge_id = charge_id
+      @merchant_id = merchant_id
+      @merchant_request_id = merchant_request_id
+      @result = result
+      @country = country unless country == SKIP
+      @network_id = network_id unless network_id == SKIP
+      @refund_id = refund_id unless refund_id == SKIP
+      @refund_status = refund_status unless refund_status == SKIP
+      @settlement = settlement unless settlement == SKIP
+      @timestamp = timestamp unless timestamp == 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.
+      charge_id = hash.key?('charge-id') ? hash['charge-id'] : nil
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_request_id =
+        hash.key?('merchant-request-id') ? hash['merchant-request-id'] : nil
+      result = Result.from_hash(hash['result']) if hash['result']
+      country = hash.key?('country') ? hash['country'] : SKIP
+      network_id = hash.key?('network-id') ? hash['network-id'] : SKIP
+      refund_id = hash.key?('refund-id') ? hash['refund-id'] : SKIP
+      refund_status = hash.key?('refund-status') ? hash['refund-status'] : SKIP
+      settlement = Settlement.from_hash(hash['settlement']) if hash['settlement']
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+
+      # Create object from extracted values.
+      RefundChargeResponse.new(charge_id,
+                               merchant_id,
+                               merchant_request_id,
+                               result,
+                               country,
+                               network_id,
+                               refund_id,
+                               refund_status,
+                               settlement,
+                               timestamp)
+    end
+
+    def self.from_element(root)
+      charge_id = XmlUtilities.from_element(root, 'charge-id', String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_request_id = XmlUtilities.from_element(root,
+                                                      'merchant-request-id',
+                                                      String)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      country = XmlUtilities.from_element(root, 'country', String)
+      network_id = XmlUtilities.from_element(root, 'network-id', String)
+      refund_id = XmlUtilities.from_element(root, 'refund-id', String)
+      refund_status = XmlUtilities.from_element(root, 'refund-status', String)
+      settlement = XmlUtilities.from_element(root, 'Settlement', Settlement)
+      timestamp = XmlUtilities.from_element(root, 'timestamp', String)
+
+      new(charge_id,
+          merchant_id,
+          merchant_request_id,
+          result,
+          country,
+          network_id,
+          refund_id,
+          refund_status,
+          settlement,
+          timestamp)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'charge-id', charge_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-request-id',
+                                     merchant_request_id)
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      XmlUtilities.add_as_subelement(doc, root, 'country', country)
+      XmlUtilities.add_as_subelement(doc, root, 'network-id', network_id)
+      XmlUtilities.add_as_subelement(doc, root, 'refund-id', refund_id)
+      XmlUtilities.add_as_subelement(doc, root, 'refund-status', refund_status)
+      XmlUtilities.add_as_subelement(doc, root, 'Settlement', settlement)
+      XmlUtilities.add_as_subelement(doc, root, 'timestamp', timestamp)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} charge_id: #{@charge_id}, merchant_id: #{@merchant_id},"\
+      " merchant_request_id: #{@merchant_request_id}, result: #{@result}, country: #{@country},"\
+      " network_id: #{@network_id}, refund_id: #{@refund_id}, refund_status: #{@refund_status},"\
+      " settlement: #{@settlement}, timestamp: #{@timestamp}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} charge_id: #{@charge_id.inspect}, merchant_id: #{@merchant_id.inspect},"\
+      " merchant_request_id: #{@merchant_request_id.inspect}, result: #{@result.inspect}, country:"\
+      " #{@country.inspect}, network_id: #{@network_id.inspect}, refund_id: #{@refund_id.inspect},"\
+      " refund_status: #{@refund_status.inspect}, settlement: #{@settlement.inspect}, timestamp:"\
+      " #{@timestamp.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/refund_status_enum.rb

@@ -0,0 +1,43 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Status of the refund at the time this response was returned. If
+  # 'in-progress' is returned, the refund call should be re-issued with the same
+  # request ID until a final status is reached. If null, no refund was created,
+  # e.g. because the request was rejected.
+  class RefundStatusEnum
+    REFUND_STATUS_ENUM = [
+      # TODO: Write general description for SUCCESS
+      SUCCESS = 'success'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for INPROGRESS
+      INPROGRESS = 'in-progress'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REFUND_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = SUCCESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'success' then SUCCESS
+      when 'failed' then FAILED
+      when 'inprogress' then INPROGRESS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/refund_type_enum.rb

@@ -0,0 +1,36 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Indicates whether refund is a regular refund or chargeback
+  class RefundTypeEnum
+    REFUND_TYPE_ENUM = [
+      # TODO: Write general description for REFUND
+      REFUND = 'refund'.freeze,
+
+      # TODO: Write general description for CHARGEBACK
+      CHARGEBACK = 'chargeback'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REFUND_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = REFUND)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'refund' then REFUND
+      when 'chargeback' then CHARGEBACK
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/register_payment_method_request.rb

@@ -0,0 +1,152 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # RegisterPaymentMethodRequest Model.
+  class RegisterPaymentMethodRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 3166-1 alpha-2 country code where the payment method should be
+    # registered
+    # @return [String]
+    attr_accessor :country
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Merchant-assigned unique request ID.
+    # @return [String]
+    attr_accessor :merchant_request_id
+
+    # Optin and Charge Request API can be made for specific Seller of Record
+    # previously registered with Boku.
+    # @return [SellerOfRecord]
+    attr_accessor :seller_of_record
+
+    # Issuer's network ID.
+    # @return [String]
+    attr_accessor :network_id
+
+    # The payment method to be registered. Each Local Payment Method provider
+    # will be its own payment method. A list of available values will be
+    # provided on demand.
+    # @return [String]
+    attr_accessor :payment_method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country'] = 'country'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_request_id'] = 'merchant-request-id'
+      @_hash['seller_of_record'] = 'seller-of-record'
+      @_hash['network_id'] = 'network-id'
+      @_hash['payment_method'] = 'payment-method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        network_id
+        payment_method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, merchant_id = nil, merchant_request_id = nil,
+                   seller_of_record = nil, network_id = SKIP,
+                   payment_method = SKIP)
+      @country = country
+      @merchant_id = merchant_id
+      @merchant_request_id = merchant_request_id
+      @seller_of_record = seller_of_record
+      @network_id = network_id unless network_id == SKIP
+      @payment_method = payment_method unless payment_method == 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
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_request_id =
+        hash.key?('merchant-request-id') ? hash['merchant-request-id'] : nil
+      seller_of_record = SellerOfRecord.from_hash(hash['seller-of-record']) if
+        hash['seller-of-record']
+      network_id = hash.key?('network-id') ? hash['network-id'] : SKIP
+      payment_method =
+        hash.key?('payment-method') ? hash['payment-method'] : SKIP
+
+      # Create object from extracted values.
+      RegisterPaymentMethodRequest.new(country,
+                                       merchant_id,
+                                       merchant_request_id,
+                                       seller_of_record,
+                                       network_id,
+                                       payment_method)
+    end
+
+    def self.from_element(root)
+      country = XmlUtilities.from_element(root, 'country', String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_request_id = XmlUtilities.from_element(root,
+                                                      'merchant-request-id',
+                                                      String)
+      seller_of_record = XmlUtilities.from_element(root, 'seller-of-record',
+                                                   SellerOfRecord)
+      network_id = XmlUtilities.from_element(root, 'network-id', String)
+      payment_method = XmlUtilities.from_element(root, 'payment-method', String)
+
+      new(country,
+          merchant_id,
+          merchant_request_id,
+          seller_of_record,
+          network_id,
+          payment_method)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'country', country)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-request-id',
+                                     merchant_request_id)
+      XmlUtilities.add_as_subelement(doc, root, 'seller-of-record',
+                                     seller_of_record)
+      XmlUtilities.add_as_subelement(doc, root, 'network-id', network_id)
+      XmlUtilities.add_as_subelement(doc, root, 'payment-method',
+                                     payment_method)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country: #{@country}, merchant_id: #{@merchant_id}, merchant_request_id:"\
+      " #{@merchant_request_id}, seller_of_record: #{@seller_of_record}, network_id:"\
+      " #{@network_id}, payment_method: #{@payment_method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country: #{@country.inspect}, merchant_id: #{@merchant_id.inspect},"\
+      " merchant_request_id: #{@merchant_request_id.inspect}, seller_of_record:"\
+      " #{@seller_of_record.inspect}, network_id: #{@network_id.inspect}, payment_method:"\
+      " #{@payment_method.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/register_payment_method_response.rb

@@ -0,0 +1,172 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # RegisterPaymentMethodResponse Model.
+  class RegisterPaymentMethodResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The 'result' element is defined in every response type. It is used to
+    # convey the outcome of an API request.
+    # @return [Result]
+    attr_accessor :result
+
+    # ISO 3166-1 alpha-2 country code.
+    # @return [String]
+    attr_accessor :country
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Merchant-assigned unique request ID.
+    # @return [String]
+    attr_accessor :merchant_request_id
+
+    # The payment method to be registered. Each Local Payment Method provider
+    # will be its own payment method. A list of available values will be
+    # provided on demand.
+    # @return [String]
+    attr_accessor :payment_method
+
+    # The status of Payment Method
+    # @return [PaymentMethodStatusEnum]
+    attr_accessor :payment_method_status
+
+    # Boku-generated ID associated with seller of record.
+    # @return [String]
+    attr_accessor :seller_of_record_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['result'] = 'result'
+      @_hash['country'] = 'country'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_request_id'] = 'merchant-request-id'
+      @_hash['payment_method'] = 'payment-method'
+      @_hash['payment_method_status'] = 'payment-method-status'
+      @_hash['seller_of_record_id'] = 'seller-of-record-id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country
+        merchant_id
+        merchant_request_id
+        payment_method
+        payment_method_status
+        seller_of_record_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(result = nil, country = SKIP, merchant_id = SKIP,
+                   merchant_request_id = SKIP, payment_method = SKIP,
+                   payment_method_status = SKIP, seller_of_record_id = SKIP)
+      @result = result
+      @country = country unless country == SKIP
+      @merchant_id = merchant_id unless merchant_id == SKIP
+      @merchant_request_id = merchant_request_id unless merchant_request_id == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @payment_method_status = payment_method_status unless payment_method_status == SKIP
+      @seller_of_record_id = seller_of_record_id unless seller_of_record_id == 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.
+      result = Result.from_hash(hash['result']) if hash['result']
+      country = hash.key?('country') ? hash['country'] : SKIP
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : SKIP
+      merchant_request_id =
+        hash.key?('merchant-request-id') ? hash['merchant-request-id'] : SKIP
+      payment_method =
+        hash.key?('payment-method') ? hash['payment-method'] : SKIP
+      payment_method_status =
+        hash.key?('payment-method-status') ? hash['payment-method-status'] : SKIP
+      seller_of_record_id =
+        hash.key?('seller-of-record-id') ? hash['seller-of-record-id'] : SKIP
+
+      # Create object from extracted values.
+      RegisterPaymentMethodResponse.new(result,
+                                        country,
+                                        merchant_id,
+                                        merchant_request_id,
+                                        payment_method,
+                                        payment_method_status,
+                                        seller_of_record_id)
+    end
+
+    def self.from_element(root)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      country = XmlUtilities.from_element(root, 'country', String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_request_id = XmlUtilities.from_element(root,
+                                                      'merchant-request-id',
+                                                      String)
+      payment_method = XmlUtilities.from_element(root, 'payment-method', String)
+      payment_method_status = XmlUtilities.from_element(root,
+                                                        'payment-method-status',
+                                                        String)
+      seller_of_record_id = XmlUtilities.from_element(root,
+                                                      'seller-of-record-id',
+                                                      String)
+
+      new(result,
+          country,
+          merchant_id,
+          merchant_request_id,
+          payment_method,
+          payment_method_status,
+          seller_of_record_id)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      XmlUtilities.add_as_subelement(doc, root, 'country', country)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-request-id',
+                                     merchant_request_id)
+      XmlUtilities.add_as_subelement(doc, root, 'payment-method',
+                                     payment_method)
+      XmlUtilities.add_as_subelement(doc, root, 'payment-method-status',
+                                     payment_method_status)
+      XmlUtilities.add_as_subelement(doc, root, 'seller-of-record-id',
+                                     seller_of_record_id)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result}, country: #{@country}, merchant_id: #{@merchant_id},"\
+      " merchant_request_id: #{@merchant_request_id}, payment_method: #{@payment_method},"\
+      " payment_method_status: #{@payment_method_status}, seller_of_record_id:"\
+      " #{@seller_of_record_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result.inspect}, country: #{@country.inspect}, merchant_id:"\
+      " #{@merchant_id.inspect}, merchant_request_id: #{@merchant_request_id.inspect},"\
+      " payment_method: #{@payment_method.inspect}, payment_method_status:"\
+      " #{@payment_method_status.inspect}, seller_of_record_id: #{@seller_of_record_id.inspect}>"
+    end
+  end
+end