fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/declined_recurring_notification.rb

@@ -0,0 +1,146 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Declined Recurring Notification Information on `expand`
+  class DeclinedRecurringNotification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID
+    # @return [String]
+    attr_accessor :id
+
+    # Declined Transaction ID
+    # @return [String]
+    attr_accessor :declined_transaction_id
+
+    # Payment Transaction ID
+    # @return [String]
+    attr_accessor :payment_transaction_id
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # User ID Created the register
+    # @return [String]
+    attr_accessor :created_user_id
+
+    # Modified Time Stamp
+    # @return [Integer]
+    attr_accessor :modified_ts
+
+    # Last User ID that updated the register
+    # @return [String]
+    attr_accessor :modified_user_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['declined_transaction_id'] = 'declined_transaction_id'
+      @_hash['payment_transaction_id'] = 'payment_transaction_id'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash['created_user_id'] = 'created_user_id'
+      @_hash['modified_ts'] = 'modified_ts'
+      @_hash['modified_user_id'] = 'modified_user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        declined_transaction_id
+        payment_transaction_id
+        created_ts
+        created_user_id
+        modified_ts
+        modified_user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        declined_transaction_id
+        payment_transaction_id
+        created_ts
+        created_user_id
+        modified_ts
+        modified_user_id
+      ]
+    end
+
+    def initialize(id = SKIP, declined_transaction_id = SKIP,
+                   payment_transaction_id = SKIP, created_ts = SKIP,
+                   created_user_id = SKIP, modified_ts = SKIP,
+                   modified_user_id = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @id = id unless id == SKIP
+      @declined_transaction_id = declined_transaction_id unless declined_transaction_id == SKIP
+      @payment_transaction_id = payment_transaction_id unless payment_transaction_id == SKIP
+      @created_ts = created_ts unless created_ts == SKIP
+      @created_user_id = created_user_id unless created_user_id == SKIP
+      @modified_ts = modified_ts unless modified_ts == SKIP
+      @modified_user_id = modified_user_id unless modified_user_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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      declined_transaction_id =
+        hash.key?('declined_transaction_id') ? hash['declined_transaction_id'] : SKIP
+      payment_transaction_id =
+        hash.key?('payment_transaction_id') ? hash['payment_transaction_id'] : SKIP
+      created_ts = hash.key?('created_ts') ? hash['created_ts'] : SKIP
+      created_user_id =
+        hash.key?('created_user_id') ? hash['created_user_id'] : SKIP
+      modified_ts = hash.key?('modified_ts') ? hash['modified_ts'] : SKIP
+      modified_user_id =
+        hash.key?('modified_user_id') ? hash['modified_user_id'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      DeclinedRecurringNotification.new(id,
+                                        declined_transaction_id,
+                                        payment_transaction_id,
+                                        created_ts,
+                                        created_user_id,
+                                        modified_ts,
+                                        modified_user_id,
+                                        additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, declined_transaction_id: #{@declined_transaction_id},"\
+      " payment_transaction_id: #{@payment_transaction_id}, created_ts: #{@created_ts},"\
+      " created_user_id: #{@created_user_id}, modified_ts: #{@modified_ts}, modified_user_id:"\
+      " #{@modified_user_id}, additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, declined_transaction_id:"\
+      " #{@declined_transaction_id.inspect}, payment_transaction_id:"\
+      " #{@payment_transaction_id.inspect}, created_ts: #{@created_ts.inspect}, created_user_id:"\
+      " #{@created_user_id.inspect}, modified_ts: #{@modified_ts.inspect}, modified_user_id:"\
+      " #{@modified_user_id.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/default_transaction_type_enum.rb

@@ -0,0 +1,40 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Default Transaction Type
+  class DefaultTransactionTypeEnum
+    DEFAULT_TRANSACTION_TYPE_ENUM = [
+      # TODO: Write general description for DEBIT
+      DEBIT = 'debit'.freeze,
+
+      # TODO: Write general description for SALE
+      SALE = 'sale'.freeze,
+
+      # TODO: Write general description for AUTHONLY
+      AUTHONLY = 'authonly'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DEFAULT_TRANSACTION_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEBIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'debit' then DEBIT
+      when 'sale' then SALE
+      when 'authonly' then AUTHONLY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/delivery_method_enum.rb

@@ -0,0 +1,54 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Delivery Method >0 - Do not send, use the expand parameter of payment_url in
+  # the create paylink request to obtain the payment_url to embed into your
+  # messaging system. > >1 - Email. Will send an email to the provided address
+  # in the email field. > >2 - SMS. Text message the Paylink. Check with sales
+  # rep for cost. > >3 - Both >
+  class DeliveryMethodEnum
+    DELIVERY_METHOD_ENUM = [
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = 0,
+
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = 2,
+
+      # TODO: Write general description for ENUM_3
+      ENUM_3 = 3
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DELIVERY_METHOD_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_0)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+      if str.match?(/\A\d+\z/)
+        num = str.to_i
+        return num if DELIVERY_METHOD_ENUM.include?(num)
+
+        return default_value
+      end
+
+      case str.downcase
+      when 'enum_0' then ENUM_0
+      when 'enum_1' then ENUM_1
+      when 'enum_2' then ENUM_2
+      when 'enum_3' then ENUM_3
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/delivery_timeframe_enum.rb

@@ -0,0 +1,46 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Indicates the merchandise delivery timeframe. >01 - Electronic Delivery >
+  # >02 - Same day shipping > >03 - Overnight shipping > >04 - Two-day or more
+  # shipping >
+  class DeliveryTimeframeEnum
+    DELIVERY_TIMEFRAME_ENUM = [
+      # TODO: Write general description for ENUM_01
+      ENUM_01 = '01'.freeze,
+
+      # TODO: Write general description for ENUM_02
+      ENUM_02 = '02'.freeze,
+
+      # TODO: Write general description for ENUM_03
+      ENUM_03 = '03'.freeze,
+
+      # TODO: Write general description for ENUM_04
+      ENUM_04 = '04'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DELIVERY_TIMEFRAME_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_01)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_01' then ENUM_01
+      when 'enum_02' then ENUM_02
+      when 'enum_03' then ENUM_03
+      when 'enum_04' then ENUM_04
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/deposit_type_enum.rb

@@ -0,0 +1,40 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Deposit Types
+  class DepositTypeEnum
+    DEPOSIT_TYPE_ENUM = [
+      # TODO: Write general description for FEE
+      FEE = 'fee'.freeze,
+
+      # TODO: Write general description for DEPOSIT
+      DEPOSIT = 'deposit'.freeze,
+
+      # TODO: Write general description for ADJUSTMENT
+      ADJUSTMENT = 'adjustment'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DEPOSIT_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = FEE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fee' then FEE
+      when 'deposit' then DEPOSIT
+      when 'adjustment' then ADJUSTMENT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/detail.rb

@@ -0,0 +1,102 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Detail Model.
+  class Detail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :path
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [Context]
+    attr_accessor :context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message'] = 'message'
+      @_hash['path'] = 'path'
+      @_hash['type'] = 'type'
+      @_hash['context'] = 'context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        message
+        path
+        type
+        context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message = SKIP, path = SKIP, type = SKIP, context = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @message = message unless message == SKIP
+      @path = path unless path == SKIP
+      @type = type unless type == SKIP
+      @context = context unless context == 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'] : SKIP
+      path = hash.key?('path') ? hash['path'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      context = Context.from_hash(hash['context']) if hash['context']
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Detail.new(message,
+                 path,
+                 type,
+                 context,
+                 additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message}, path: #{@path}, type: #{@type}, context: #{@context},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message: #{@message.inspect}, path: #{@path.inspect}, type:"\
+      " #{@type.inspect}, context: #{@context.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/detail1.rb

@@ -0,0 +1,263 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Error details
+  class Detail1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Universally unique transaction identifier assigned by the 3DS Server to
+    # identify a single transaction. It has the same value as the corresponding
+    # received authentication request. This value has 36 characters in a format
+    # defined in IETF RFC 4122.
+    # @return [String]
+    attr_accessor :three_ds_server_trans_id
+
+    # Universally Unique transaction identifier assigned by the ACS to identify
+    # a single transaction.
+    # @return [String]
+    attr_accessor :acs_trans_id
+
+    # Universally unique transaction identifier assigned by the DS to identify a
+    # single transaction.
+    # @return [String]
+    attr_accessor :ds_trans_id
+
+    # Code indicating the type of problem identified.
+    # >101 - Message received invalid
+    # >
+    # >102 - Message version number not supported
+    # >
+    # >103 - Sent messages limit exceeded. Only used for PReq
+    # >
+    # >201 - Required element missing
+    # >
+    # >202 - Critical message extension not recognized
+    # >
+    # >203 - Format on one or more elements is invalid according to the specs
+    # >
+    # >204 - Duplicate data element
+    # >
+    # >205 - Card range overlap
+    # >
+    # >206 - Card range action indicator
+    # >
+    # >207 - Value in the reserved value range
+    # >
+    # >301 - Transaction id is not recognized
+    # >
+    # >302 - Data decryption failure
+    # >
+    # >303 - Access denied, invalid endpoint
+    # >
+    # >304 - ISO code is not valid
+    # >
+    # >305 - Transaction data is not valid
+    # >
+    # >306 - Merchant category code is not valid for payment system
+    # >
+    # >307 - Serial number is not valid
+    # >
+    # >308 - Signature verification failure
+    # >
+    # >309 - Validation against content security policies failure
+    # >
+    # >310 - Incorrect cryptographic algorithm
+    # >
+    # >311 - Incorrect kid
+    # >
+    # >312 - Duplicate message
+    # >
+    # >313 - Inconsistent RReq message
+    # >
+    # >314 - Multiple creq messages are not supported
+    # >
+    # >315 - CReq message received after the RReq message
+    # >
+    # >402 - Transaction timed out
+    # >
+    # >403 - Transient system failure
+    # >
+    # >404 - Permanent system failure
+    # >
+    # >405 - System connection failure
+    # >
+    # >911 - UnionPay specific error code. Present when Data fields relevance
+    # check failed (ECI value and AV appearance are inconsistent with
+    # transaction status).
+    # >
+    # >912 - UnionPay specific error code. Present when duplicated transaction
+    # ID (Transaction ID should be unique for each AReq request).
+    # >
+    # @return [String]
+    attr_accessor :error_code
+
+    # Code indicating the 3-D Secure component that identified the error.
+    # >C - 3DS SDK
+    # >
+    # >S - 3DS Server
+    # >
+    # >D - DS
+    # >
+    # >A - ACS
+    # >
+    # @return [String]
+    attr_accessor :error_component
+
+    # Text describing the problem identified.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Additional detail regarding the problem identified.
+    # @return [String]
+    attr_accessor :error_detail
+
+    # Universally unique transaction identifier assigned by the 3DS SDK to
+    # identify a single transaction.
+    # @return [String]
+    attr_accessor :sdk_trans_id
+
+    # The Message Type that was identified as erroneous.
+    # >AReq - Authentication request
+    # >
+    # >ARes - Authentication response
+    # >
+    # >CReq - Challenge request
+    # >
+    # >CRes - Challenge response
+    # >
+    # >PReq - Preparation request
+    # >
+    # >PRes - Preparation response
+    # >
+    # >RReq - Results request
+    # >
+    # >RRes - Results response
+    # >
+    # >Erro - Error
+    # >
+    # >3dsMethodReq - 3DS method request
+    # >
+    # >OReq - Operation request. Since 2.3.1
+    # >
+    # >ORes - Operation response. Since 2.3.1
+    # >
+    # @return [String]
+    attr_accessor :error_message_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['three_ds_server_trans_id'] = 'three_ds_server_trans_id'
+      @_hash['acs_trans_id'] = 'acs_trans_id'
+      @_hash['ds_trans_id'] = 'ds_trans_id'
+      @_hash['error_code'] = 'error_code'
+      @_hash['error_component'] = 'error_component'
+      @_hash['error_description'] = 'error_description'
+      @_hash['error_detail'] = 'error_detail'
+      @_hash['sdk_trans_id'] = 'sdk_trans_id'
+      @_hash['error_message_type'] = 'error_message_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        three_ds_server_trans_id
+        acs_trans_id
+        ds_trans_id
+        error_code
+        error_component
+        error_description
+        error_detail
+        sdk_trans_id
+        error_message_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(three_ds_server_trans_id = SKIP, acs_trans_id = SKIP,
+                   ds_trans_id = SKIP, error_code = SKIP,
+                   error_component = SKIP, error_description = SKIP,
+                   error_detail = SKIP, sdk_trans_id = SKIP,
+                   error_message_type = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @three_ds_server_trans_id = three_ds_server_trans_id unless three_ds_server_trans_id == SKIP
+      @acs_trans_id = acs_trans_id unless acs_trans_id == SKIP
+      @ds_trans_id = ds_trans_id unless ds_trans_id == SKIP
+      @error_code = error_code unless error_code == SKIP
+      @error_component = error_component unless error_component == SKIP
+      @error_description = error_description unless error_description == SKIP
+      @error_detail = error_detail unless error_detail == SKIP
+      @sdk_trans_id = sdk_trans_id unless sdk_trans_id == SKIP
+      @error_message_type = error_message_type unless error_message_type == 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.
+      three_ds_server_trans_id =
+        hash.key?('three_ds_server_trans_id') ? hash['three_ds_server_trans_id'] : SKIP
+      acs_trans_id = hash.key?('acs_trans_id') ? hash['acs_trans_id'] : SKIP
+      ds_trans_id = hash.key?('ds_trans_id') ? hash['ds_trans_id'] : SKIP
+      error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      error_component =
+        hash.key?('error_component') ? hash['error_component'] : SKIP
+      error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+      error_detail = hash.key?('error_detail') ? hash['error_detail'] : SKIP
+      sdk_trans_id = hash.key?('sdk_trans_id') ? hash['sdk_trans_id'] : SKIP
+      error_message_type =
+        hash.key?('error_message_type') ? hash['error_message_type'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Detail1.new(three_ds_server_trans_id,
+                  acs_trans_id,
+                  ds_trans_id,
+                  error_code,
+                  error_component,
+                  error_description,
+                  error_detail,
+                  sdk_trans_id,
+                  error_message_type,
+                  additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} three_ds_server_trans_id: #{@three_ds_server_trans_id}, acs_trans_id:"\
+      " #{@acs_trans_id}, ds_trans_id: #{@ds_trans_id}, error_code: #{@error_code},"\
+      " error_component: #{@error_component}, error_description: #{@error_description},"\
+      " error_detail: #{@error_detail}, sdk_trans_id: #{@sdk_trans_id}, error_message_type:"\
+      " #{@error_message_type}, additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} three_ds_server_trans_id: #{@three_ds_server_trans_id.inspect},"\
+      " acs_trans_id: #{@acs_trans_id.inspect}, ds_trans_id: #{@ds_trans_id.inspect}, error_code:"\
+      " #{@error_code.inspect}, error_component: #{@error_component.inspect}, error_description:"\
+      " #{@error_description.inspect}, error_detail: #{@error_detail.inspect}, sdk_trans_id:"\
+      " #{@sdk_trans_id.inspect}, error_message_type: #{@error_message_type.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end