bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/refund.rb

@@ -0,0 +1,249 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Refund Model.
+  class Refund < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the charge being refunded
+    # @return [String]
+    attr_accessor :charge_id
+
+    # ISO 3166-1 alpha-2 country code.
+    # @return [String]
+    attr_accessor :country
+
+    # ISO 4217 three-letter currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Merchant-assigned refund ID. 
+    # _***Boku recommends merchants send this ID for future reference**_
+    # @return [String]
+    attr_accessor :merchant_refund_id
+
+    # The merchant transaction ID of the charge being refunded if it was
+    # provided in the original charge request. Otherwise, the merchant request
+    # ID of the charge being refunded. 
+    # _***Boku recommends merchants send this ID for future reference**_
+    # @return [String]
+    attr_accessor :merchant_transaction_id
+
+    # Issuer's Network ID.
+    # @return [String]
+    attr_accessor :network_id
+
+    # Boku refund reason code
+    # @return [Integer]
+    attr_accessor :reason_code
+
+    # Total amount refunded or attempted to refund, including tax.
+    # @return [Float]
+    attr_accessor :refund_amount
+
+    # Unique ID for the refund generated by Boku.
+    # @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
+
+    # 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
+
+    # Time original refund request was received ("YYYY-MM-DD hh:mm:ss").
+    # All timestamps are in UTC.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Indicates whether refund is a regular refund or chargeback
+    # @return [RefundTypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['charge_id'] = 'charge-id'
+      @_hash['country'] = 'country'
+      @_hash['currency'] = 'currency'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_refund_id'] = 'merchant-refund-id'
+      @_hash['merchant_transaction_id'] = 'merchant-transaction-id'
+      @_hash['network_id'] = 'network-id'
+      @_hash['reason_code'] = 'reason-code'
+      @_hash['refund_amount'] = 'refund-amount'
+      @_hash['refund_id'] = 'refund-id'
+      @_hash['refund_status'] = 'refund-status'
+      @_hash['result'] = 'result'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(charge_id = nil, country = nil, currency = nil,
+                   merchant_id = nil, merchant_refund_id = nil,
+                   merchant_transaction_id = nil, network_id = nil,
+                   reason_code = nil, refund_amount = nil, refund_id = nil,
+                   refund_status = nil, result = nil, timestamp = nil,
+                   type = nil)
+      @charge_id = charge_id
+      @country = country
+      @currency = currency
+      @merchant_id = merchant_id
+      @merchant_refund_id = merchant_refund_id
+      @merchant_transaction_id = merchant_transaction_id
+      @network_id = network_id
+      @reason_code = reason_code
+      @refund_amount = refund_amount
+      @refund_id = refund_id
+      @refund_status = refund_status
+      @result = result
+      @timestamp = timestamp
+      @type = type
+    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
+      country = hash.key?('country') ? hash['country'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_refund_id =
+        hash.key?('merchant-refund-id') ? hash['merchant-refund-id'] : nil
+      merchant_transaction_id =
+        hash.key?('merchant-transaction-id') ? hash['merchant-transaction-id'] : nil
+      network_id = hash.key?('network-id') ? hash['network-id'] : nil
+      reason_code = hash.key?('reason-code') ? hash['reason-code'] : nil
+      refund_amount = hash.key?('refund-amount') ? hash['refund-amount'] : nil
+      refund_id = hash.key?('refund-id') ? hash['refund-id'] : nil
+      refund_status = hash.key?('refund-status') ? hash['refund-status'] : nil
+      result = Result.from_hash(hash['result']) if hash['result']
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+
+      # Create object from extracted values.
+      Refund.new(charge_id,
+                 country,
+                 currency,
+                 merchant_id,
+                 merchant_refund_id,
+                 merchant_transaction_id,
+                 network_id,
+                 reason_code,
+                 refund_amount,
+                 refund_id,
+                 refund_status,
+                 result,
+                 timestamp,
+                 type)
+    end
+
+    def self.from_element(root)
+      charge_id = XmlUtilities.from_element(root, 'charge-id', String)
+      country = XmlUtilities.from_element(root, 'country', String)
+      currency = XmlUtilities.from_element(root, 'currency', String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_refund_id = XmlUtilities.from_element(root, 'merchant-refund-id',
+                                                     String)
+      merchant_transaction_id = XmlUtilities.from_element(
+        root, 'merchant-transaction-id', String
+      )
+      network_id = XmlUtilities.from_element(root, 'network-id', String)
+      reason_code = XmlUtilities.from_element(root, 'reason-code', Integer)
+      refund_amount = XmlUtilities.from_element(root, 'refund-amount', Float)
+      refund_id = XmlUtilities.from_element(root, 'refund-id', String)
+      refund_status = XmlUtilities.from_element(root, 'refund-status', String)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      timestamp = XmlUtilities.from_element(root, 'timestamp', String)
+      type = XmlUtilities.from_element(root, 'type', String)
+
+      new(charge_id,
+          country,
+          currency,
+          merchant_id,
+          merchant_refund_id,
+          merchant_transaction_id,
+          network_id,
+          reason_code,
+          refund_amount,
+          refund_id,
+          refund_status,
+          result,
+          timestamp,
+          type)
+    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, 'country', country)
+      XmlUtilities.add_as_subelement(doc, root, 'currency', currency)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-refund-id',
+                                     merchant_refund_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-transaction-id',
+                                     merchant_transaction_id)
+      XmlUtilities.add_as_subelement(doc, root, 'network-id', network_id)
+      XmlUtilities.add_as_subelement(doc, root, 'reason-code', reason_code)
+      XmlUtilities.add_as_subelement(doc, root, 'refund-amount', refund_amount)
+      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, 'result', result)
+      XmlUtilities.add_as_subelement(doc, root, 'timestamp', timestamp)
+      XmlUtilities.add_as_subelement(doc, root, 'type', type)
+
+      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}, country: #{@country}, currency: #{@currency},"\
+      " merchant_id: #{@merchant_id}, merchant_refund_id: #{@merchant_refund_id},"\
+      " merchant_transaction_id: #{@merchant_transaction_id}, network_id: #{@network_id},"\
+      " reason_code: #{@reason_code}, refund_amount: #{@refund_amount}, refund_id: #{@refund_id},"\
+      " refund_status: #{@refund_status}, result: #{@result}, timestamp: #{@timestamp}, type:"\
+      " #{@type}>"
+    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}, country: #{@country.inspect}, currency:"\
+      " #{@currency.inspect}, merchant_id: #{@merchant_id.inspect}, merchant_refund_id:"\
+      " #{@merchant_refund_id.inspect}, merchant_transaction_id:"\
+      " #{@merchant_transaction_id.inspect}, network_id: #{@network_id.inspect}, reason_code:"\
+      " #{@reason_code.inspect}, refund_amount: #{@refund_amount.inspect}, refund_id:"\
+      " #{@refund_id.inspect}, refund_status: #{@refund_status.inspect}, result:"\
+      " #{@result.inspect}, timestamp: #{@timestamp.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/refund_charge_notification.rb

@@ -0,0 +1,88 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # RefundChargeNotification Model.
+  class RefundChargeNotification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Flag to indicate if a notification should be sent for this refund.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send
+
+    # Supplies the URL for Boku to send a notification once the refund is
+    # complete.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['send'] = 'send'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(send = false, url = SKIP)
+      @send = send
+      @url = url unless url == 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.
+      send = hash['send'] ||= false
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create object from extracted values.
+      RefundChargeNotification.new(send,
+                                   url)
+    end
+
+    def self.from_element(root)
+      send = XmlUtilities.from_attribute(root, 'send', TrueClass)
+      url = XmlUtilities.from_attribute(root, 'url', String)
+
+      new(send,
+          url)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_attribute(root, 'send', send)
+      XmlUtilities.add_as_attribute(root, 'url', url)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} send: #{@send}, url: #{@url}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} send: #{@send.inspect}, url: #{@url.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/refund_charge_request.rb

@@ -0,0 +1,231 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'refund-charge' Request - General Parameters
+  class RefundChargeRequest < 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 refund ID
+    # _***Boku recommends merchants send this ID for future reference**_
+    # @return [String]
+    attr_accessor :merchant_refund_id
+
+    # 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
+
+    # [Boku refund reason code](page:refund-reason-codes)
+    # @return [Integer]
+    attr_accessor :reason_code
+
+    # 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 [RefundChargeNotification]
+    attr_accessor :notification
+
+    # Refund amount. Defaults to the original charge request's total-amount.
+    # @return [Float]
+    attr_accessor :refund_amount
+
+    # **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
+
+    # Flag to indicate if Boku automated retry logic should be skipped for this
+    # refund.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skip_retry
+
+    # 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_id'] = 'charge-id'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_refund_id'] = 'merchant-refund-id'
+      @_hash['merchant_request_id'] = 'merchant-request-id'
+      @_hash['reason_code'] = 'reason-code'
+      @_hash['country'] = 'country'
+      @_hash['currency'] = 'currency'
+      @_hash['notification'] = 'notification'
+      @_hash['refund_amount'] = 'refund-amount'
+      @_hash['settlement'] = 'settlement'
+      @_hash['skip_retry'] = 'skip-retry'
+      @_hash['timeout'] = 'timeout'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country
+        currency
+        notification
+        refund_amount
+        settlement
+        skip_retry
+        timeout
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(charge_id = nil, merchant_id = nil, merchant_refund_id = nil,
+                   merchant_request_id = nil, reason_code = nil, country = SKIP,
+                   currency = SKIP, notification = SKIP, refund_amount = SKIP,
+                   settlement = SKIP, skip_retry = false, timeout = SKIP)
+      @charge_id = charge_id
+      @merchant_id = merchant_id
+      @merchant_refund_id = merchant_refund_id
+      @merchant_request_id = merchant_request_id
+      @reason_code = reason_code
+      @country = country unless country == SKIP
+      @currency = currency unless currency == SKIP
+      @notification = notification unless notification == SKIP
+      @refund_amount = refund_amount unless refund_amount == SKIP
+      @settlement = settlement unless settlement == SKIP
+      @skip_retry = skip_retry unless skip_retry == 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.
+      charge_id = hash.key?('charge-id') ? hash['charge-id'] : nil
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_refund_id =
+        hash.key?('merchant-refund-id') ? hash['merchant-refund-id'] : nil
+      merchant_request_id =
+        hash.key?('merchant-request-id') ? hash['merchant-request-id'] : nil
+      reason_code = hash.key?('reason-code') ? hash['reason-code'] : nil
+      country = hash.key?('country') ? hash['country'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      notification = RefundChargeNotification.from_hash(hash['notification']) if
+        hash['notification']
+      refund_amount = hash.key?('refund-amount') ? hash['refund-amount'] : SKIP
+      settlement = Settlement.from_hash(hash['settlement']) if hash['settlement']
+      skip_retry = hash['skip-retry'] ||= false
+      timeout = Timeout.from_hash(hash['timeout']) if hash['timeout']
+
+      # Create object from extracted values.
+      RefundChargeRequest.new(charge_id,
+                              merchant_id,
+                              merchant_refund_id,
+                              merchant_request_id,
+                              reason_code,
+                              country,
+                              currency,
+                              notification,
+                              refund_amount,
+                              settlement,
+                              skip_retry,
+                              timeout)
+    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_refund_id = XmlUtilities.from_element(root, 'merchant-refund-id',
+                                                     String)
+      merchant_request_id = XmlUtilities.from_element(root,
+                                                      'merchant-request-id',
+                                                      String)
+      reason_code = XmlUtilities.from_element(root, 'reason-code', Integer)
+      country = XmlUtilities.from_element(root, 'country', String)
+      currency = XmlUtilities.from_element(root, 'currency', String)
+      notification = XmlUtilities.from_element(root, 'notification',
+                                               RefundChargeNotification)
+      refund_amount = XmlUtilities.from_element(root, 'refund-amount', Float)
+      settlement = XmlUtilities.from_element(root, 'Settlement', Settlement)
+      skip_retry = XmlUtilities.from_element(root, 'skip-retry', TrueClass)
+      timeout = XmlUtilities.from_element(root, 'timeout', Timeout)
+
+      new(charge_id,
+          merchant_id,
+          merchant_refund_id,
+          merchant_request_id,
+          reason_code,
+          country,
+          currency,
+          notification,
+          refund_amount,
+          settlement,
+          skip_retry,
+          timeout)
+    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-refund-id',
+                                     merchant_refund_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-request-id',
+                                     merchant_request_id)
+      XmlUtilities.add_as_subelement(doc, root, 'reason-code', reason_code)
+      XmlUtilities.add_as_subelement(doc, root, 'country', country)
+      XmlUtilities.add_as_subelement(doc, root, 'currency', currency)
+      XmlUtilities.add_as_subelement(doc, root, 'notification', notification)
+      XmlUtilities.add_as_subelement(doc, root, 'refund-amount', refund_amount)
+      XmlUtilities.add_as_subelement(doc, root, 'Settlement', settlement)
+      XmlUtilities.add_as_subelement(doc, root, 'skip-retry', skip_retry)
+      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_id: #{@charge_id}, merchant_id: #{@merchant_id}, merchant_refund_id:"\
+      " #{@merchant_refund_id}, merchant_request_id: #{@merchant_request_id}, reason_code:"\
+      " #{@reason_code}, country: #{@country}, currency: #{@currency}, notification:"\
+      " #{@notification}, refund_amount: #{@refund_amount}, settlement: #{@settlement},"\
+      " skip_retry: #{@skip_retry}, timeout: #{@timeout}>"
+    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_refund_id: #{@merchant_refund_id.inspect}, merchant_request_id:"\
+      " #{@merchant_request_id.inspect}, reason_code: #{@reason_code.inspect}, country:"\
+      " #{@country.inspect}, currency: #{@currency.inspect}, notification:"\
+      " #{@notification.inspect}, refund_amount: #{@refund_amount.inspect}, settlement:"\
+      " #{@settlement.inspect}, skip_retry: #{@skip_retry.inspect}, timeout: #{@timeout.inspect}>"
+    end
+  end
+end