bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/result.rb

@@ -0,0 +1,154 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # The 'result' element is defined in every response type. It is used to convey
+  # the outcome of an API request.
+  class Result < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Description of the reason code
+    # @return [String]
+    attr_accessor :message
+
+    # Provides additional information for the status
+    # @return [Integer]
+    attr_accessor :reason_code
+
+    # **true** if the request can be retried; **false** otherwise
+    # @return [TrueClass | FalseClass]
+    attr_accessor :retriable
+
+    # The status of the operation
+    # @return [ResultStatusEnum]
+    attr_accessor :status
+
+    # The status of the operation
+    # @return [Array[InvalidRequestField]]
+    attr_accessor :invalid_request_fields
+
+    # Minimum milliseconds to delay before re-trying request
+    # @return [Integer]
+    attr_accessor :retry_delay
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash['reason_code'] = 'reason-code'
+      @_hash['retriable'] = 'retriable'
+      @_hash['status'] = 'status'
+      @_hash['invalid_request_fields'] = 'invalid-request-fields'
+      @_hash['retry_delay'] = 'retry-delay'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        invalid_request_fields
+        retry_delay
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message = nil, reason_code = nil, retriable = nil,
+                   status = nil, invalid_request_fields = SKIP,
+                   retry_delay = SKIP)
+      @message = message
+      @reason_code = reason_code
+      @retriable = retriable
+      @status = status
+      @invalid_request_fields = invalid_request_fields unless invalid_request_fields == SKIP
+      @retry_delay = retry_delay unless retry_delay == 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.
+      message = hash.key?('message') ? hash['message'] : nil
+      reason_code = hash.key?('reason-code') ? hash['reason-code'] : nil
+      retriable = hash.key?('retriable') ? hash['retriable'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      # Parameter is an array, so we need to iterate through it
+      invalid_request_fields = nil
+      unless hash['invalid-request-fields'].nil?
+        invalid_request_fields = []
+        hash['invalid-request-fields'].each do |structure|
+          invalid_request_fields << (InvalidRequestField.from_hash(structure) if structure)
+        end
+      end
+
+      invalid_request_fields = SKIP unless hash.key?('invalid-request-fields')
+      retry_delay = hash.key?('retry-delay') ? hash['retry-delay'] : SKIP
+
+      # Create object from extracted values.
+      Result.new(message,
+                 reason_code,
+                 retriable,
+                 status,
+                 invalid_request_fields,
+                 retry_delay)
+    end
+
+    def self.from_element(root)
+      message = XmlUtilities.from_element(root, 'message', String)
+      reason_code = XmlUtilities.from_element(root, 'reason-code', Integer)
+      retriable = XmlUtilities.from_element(root, 'retriable', TrueClass)
+      status = XmlUtilities.from_attribute(root, 'status', String)
+      invalid_request_fields = XmlUtilities.from_element_to_array(
+        root, 'field', InvalidRequestField,
+        wrapping_element_name: 'invalid-request-fields'
+      )
+      retry_delay = XmlUtilities.from_element(root, 'retry-delay', Integer)
+
+      new(message,
+          reason_code,
+          retriable,
+          status,
+          invalid_request_fields,
+          retry_delay)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'message', message)
+      XmlUtilities.add_as_subelement(doc, root, 'reason-code', reason_code)
+      XmlUtilities.add_as_subelement(doc, root, 'retriable', retriable)
+      XmlUtilities.add_as_attribute(root, 'status', status)
+      XmlUtilities.add_array_as_subelement(
+        doc, root, 'field', invalid_request_fields,
+        wrapping_element_name: 'invalid-request-fields'
+      )
+      XmlUtilities.add_as_subelement(doc, root, 'retry-delay', retry_delay)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message}, reason_code: #{@reason_code}, retriable:"\
+      " #{@retriable}, status: #{@status}, invalid_request_fields: #{@invalid_request_fields},"\
+      " retry_delay: #{@retry_delay}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message.inspect}, reason_code: #{@reason_code.inspect},"\
+      " retriable: #{@retriable.inspect}, status: #{@status.inspect}, invalid_request_fields:"\
+      " #{@invalid_request_fields.inspect}, retry_delay: #{@retry_delay.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/result_status_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
+  # The status of the operation
+  class ResultStatusEnum
+    RESULT_STATUS_ENUM = [
+      # The request was processed successfully
+      OK = 'OK'.freeze,
+
+      # A problem occurred while processing the request
+      ERROR = 'ERROR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RESULT_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = OK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ok' then OK
+      when 'error' then ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/reversal.rb

@@ -0,0 +1,89 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Contains information about the reversal status of this transaction. If
+  # present, charge may be considered reversed. If not present, no reversal
+  # request has been received.
+  class Reversal < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boku-assigned reversal ID allocated at the time of the original reversal
+    # request
+    # @return [String]
+    attr_accessor :reversal_id
+
+    # Time original reverse-charge 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['reversal_id'] = 'reversal-id'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reversal_id = nil, timestamp = nil)
+      @reversal_id = reversal_id
+      @timestamp = timestamp
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reversal_id = hash.key?('reversal-id') ? hash['reversal-id'] : nil
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : nil
+
+      # Create object from extracted values.
+      Reversal.new(reversal_id,
+                   timestamp)
+    end
+
+    def self.from_element(root)
+      reversal_id = XmlUtilities.from_element(root, 'reversal-id', String)
+      timestamp = XmlUtilities.from_element(root, 'timestamp', String)
+
+      new(reversal_id,
+          timestamp)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'reversal-id', reversal_id)
+      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} reversal_id: #{@reversal_id}, timestamp: #{@timestamp}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reversal_id: #{@reversal_id.inspect}, timestamp: #{@timestamp.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/reverse_charge_request.rb

@@ -0,0 +1,104 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'reverse-charge' Request - General Parameters
+  class ReverseChargeRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 3166-1 alpha-2 country code of the original charge to be reversed
+    # (same value as the original charge request).
+    # @return [String]
+    attr_accessor :country
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Merchant-assigned request ID of the original charge request being
+    # reversed.
+    # @return [String]
+    attr_accessor :merchant_request_id
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, merchant_id = nil, merchant_request_id = nil)
+      @country = country
+      @merchant_id = merchant_id
+      @merchant_request_id = merchant_request_id
+    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
+
+      # Create object from extracted values.
+      ReverseChargeRequest.new(country,
+                               merchant_id,
+                               merchant_request_id)
+    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)
+
+      new(country,
+          merchant_id,
+          merchant_request_id)
+    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)
+
+      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}>"
+    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}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/reverse_charge_response.rb

@@ -0,0 +1,157 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'reverse-charge' Response - General Elements
+  class ReverseChargeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 3166-1 alpha-2 country code.
+    # @return [String]
+    attr_accessor :country
+
+    # 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
+
+    # Unique ID for each charge generated by Boku.
+    # @return [String]
+    attr_accessor :charge_id
+
+    # Boku-assigned reversal ID.
+    # @return [String]
+    attr_accessor :reversal_id
+
+    # 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['country'] = 'country'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_request_id'] = 'merchant-request-id'
+      @_hash['result'] = 'result'
+      @_hash['charge_id'] = 'charge-id'
+      @_hash['reversal_id'] = 'reversal-id'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        charge_id
+        reversal_id
+        timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, merchant_id = nil, merchant_request_id = nil,
+                   result = nil, charge_id = SKIP, reversal_id = SKIP,
+                   timestamp = SKIP)
+      @country = country
+      @merchant_id = merchant_id
+      @merchant_request_id = merchant_request_id
+      @result = result
+      @charge_id = charge_id unless charge_id == SKIP
+      @reversal_id = reversal_id unless reversal_id == 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.
+      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
+      result = Result.from_hash(hash['result']) if hash['result']
+      charge_id = hash.key?('charge-id') ? hash['charge-id'] : SKIP
+      reversal_id = hash.key?('reversal-id') ? hash['reversal-id'] : SKIP
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+
+      # Create object from extracted values.
+      ReverseChargeResponse.new(country,
+                                merchant_id,
+                                merchant_request_id,
+                                result,
+                                charge_id,
+                                reversal_id,
+                                timestamp)
+    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)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      charge_id = XmlUtilities.from_element(root, 'charge-id', String)
+      reversal_id = XmlUtilities.from_element(root, 'reversal-id', String)
+      timestamp = XmlUtilities.from_element(root, 'timestamp', String)
+
+      new(country,
+          merchant_id,
+          merchant_request_id,
+          result,
+          charge_id,
+          reversal_id,
+          timestamp)
+    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, 'result', result)
+      XmlUtilities.add_as_subelement(doc, root, 'charge-id', charge_id)
+      XmlUtilities.add_as_subelement(doc, root, 'reversal-id', reversal_id)
+      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} country: #{@country}, merchant_id: #{@merchant_id}, merchant_request_id:"\
+      " #{@merchant_request_id}, result: #{@result}, charge_id: #{@charge_id}, reversal_id:"\
+      " #{@reversal_id}, timestamp: #{@timestamp}>"
+    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}, result: #{@result.inspect},"\
+      " charge_id: #{@charge_id.inspect}, reversal_id: #{@reversal_id.inspect}, timestamp:"\
+      " #{@timestamp.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/seller_of_record.rb

@@ -0,0 +1,76 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Optin and Charge Request API can be made for specific Seller of Record
+  # previously registered with Boku.
+  class SellerOfRecord < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the Seller of Record, previously registered with
+    # Boku. The ID is a 24-character alphanumeric string generated by Boku.
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil)
+      @id = id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+
+      # Create object from extracted values.
+      SellerOfRecord.new(id)
+    end
+
+    def self.from_element(root)
+      id = XmlUtilities.from_element(root, 'id', String)
+
+      new(id)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'id', id)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/seller_of_record_status_enum.rb

@@ -0,0 +1,44 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # The status of Seller Of Record
+  class SellerOfRecordStatusEnum
+    SELLER_OF_RECORD_STATUS_ENUM = [
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for APPROVED
+      APPROVED = 'approved'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'rejected'.freeze,
+
+      # TODO: Write general description for SUSPENDED
+      SUSPENDED = 'suspended'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SELLER_OF_RECORD_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = PENDING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending' then PENDING
+      when 'approved' then APPROVED
+      when 'rejected' then REJECTED
+      when 'suspended' then SUSPENDED
+      else
+        default_value
+      end
+    end
+  end
+end