payrix-api-sdk 1.0.0

data/lib/payrix/models/txn_ref_stage_enum.rb

@@ -0,0 +1,48 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # txnRefStage.
+  class TxnRefStageEnum
+    TXN_REF_STAGE_ENUM = [
+      # Related to transaction authorization stage.
+      AUTH = 'auth'.freeze,
+
+      # Related to transaction capture stage.
+      CAPTURE = 'capture'.freeze,
+
+      # Transaction is in draft stage. Draft locator for transaction.
+      DRAFT = 'draft'.freeze,
+
+      # Import Transaction Reference file.
+      FILE = 'file'.freeze,
+
+      # Network-related reference.
+      NETWORK = 'network'.freeze,
+
+      # Related to transaction refund stage.
+      REFUND = 'refund'.freeze,
+
+      # A reference to the retrieval number (a reference exchanged with the
+      # processor for later cross-reference).
+      RETRIEVAL = 'retrieval'.freeze,
+
+      # Threat Matrix.
+      THREATMETRIX = 'threatMetrix'.freeze,
+
+      # Transaction hash reference.
+      TXNHASH = 'txnHash'.freeze,
+
+      # Acquirer Reference Number.
+      ARN = 'ARN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TXN_REF_STAGE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/txn_refs_response.rb

@@ -0,0 +1,186 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # TxnRefsResponse Model.
+  class TxnRefsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of this resource.
+    # @return [String]
+    attr_accessor :id
+
+    # The date and time at which this resource was created. The format should be
+    # YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :created
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :modified
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [Object]
+    attr_accessor :creator
+
+    # The identifier of the Login that last modified this resource.
+    # @return [String]
+    attr_accessor :modifier
+
+    # The parent transaction that owns this txnRef and to which this reference
+    # applies.
+    # @return [String]
+    attr_accessor :txn
+
+    # The reference value retrieved from the third party (platform).
+    # @return [String]
+    attr_accessor :ref
+
+    # An indicator showing what this txnRef refers to, such as auth, capture,
+    # draft, file, refund, or an unknown value.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `auth`  -  **Related to transaction authorization stage.**
+    # - `capture`  -  **Related to transaction capture stage.**
+    # - `draft`  -  **Transaction is in draft stage. Draft locator for
+    # transaction.**
+    # - `file`  -  **Import Transaction Reference file.**
+    # - `refund`  -  **Related to transaction refund stage.**
+    # - `retrieval`  -  **A reference to the retrieval number (a reference
+    # exchanged with the processor for later cross-reference).**
+    # - `threatMetrix`  -  **Threat Matrix.**
+    # </details>
+    # @return [TxnRefStageEnum]
+    attr_accessor :stage
+
+    # The platform used to process this resource.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `APPLE` - **The Apple Payment Processor.**
+    # - `ELAVON` - **The Elavon processor.**
+    # - `FIRSTDATA` - **The FirstData processor.**
+    # - `GOOGLE` - **The Google Payment Processor.**
+    # - `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP)
+    # processor.**
+    # - `VCORE` - **The WorldPay (aka Vantiv) Core processor.**
+    # - `TDBANKCA` - **External funding with TD Bank Canada via the Operating
+    # Account.**
+    # - `WELLSACH` - **The Wells Fargo ACH processor.**
+    # - `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**
+    # - `WFSINGLE` - **The WFSINGLE processor.**
+    # - `WORLDPAY` - **The WORLDPAY processor.**
+    # </details>
+    # @return [Platform1Enum]
+    attr_accessor :platform
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['created'] = 'created'
+      @_hash['modified'] = 'modified'
+      @_hash['creator'] = 'creator'
+      @_hash['modifier'] = 'modifier'
+      @_hash['txn'] = 'txn'
+      @_hash['ref'] = 'ref'
+      @_hash['stage'] = 'stage'
+      @_hash['platform'] = 'platform'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created
+        modified
+        creator
+        modifier
+        txn
+        ref
+        stage
+        platform
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, created = SKIP, modified = SKIP, creator = SKIP,
+                   modifier = SKIP, txn = SKIP, ref = SKIP, stage = SKIP,
+                   platform = SKIP)
+      @id = id unless id == SKIP
+      @created = created unless created == SKIP
+      @modified = modified unless modified == SKIP
+      @creator = creator unless creator == SKIP
+      @modifier = modifier unless modifier == SKIP
+      @txn = txn unless txn == SKIP
+      @ref = ref unless ref == SKIP
+      @stage = stage unless stage == SKIP
+      @platform = platform unless platform == 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
+      created = hash.key?('created') ? hash['created'] : SKIP
+      modified = hash.key?('modified') ? hash['modified'] : SKIP
+      creator = hash.key?('creator') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:TxnRefsResponseCreator), hash['creator']
+      ) : SKIP
+      modifier = hash.key?('modifier') ? hash['modifier'] : SKIP
+      txn = hash.key?('txn') ? hash['txn'] : SKIP
+      ref = hash.key?('ref') ? hash['ref'] : SKIP
+      stage = hash.key?('stage') ? hash['stage'] : SKIP
+      platform = hash.key?('platform') ? hash['platform'] : SKIP
+
+      # Create object from extracted values.
+      TxnRefsResponse.new(id,
+                          created,
+                          modified,
+                          creator,
+                          modifier,
+                          txn,
+                          ref,
+                          stage,
+                          platform)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TxnRefsResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, created: #{@created}, modified: #{@modified}, creator:"\
+      " #{@creator}, modifier: #{@modifier}, txn: #{@txn}, ref: #{@ref}, stage: #{@stage},"\
+      " platform: #{@platform}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, created: #{@created.inspect}, modified:"\
+      " #{@modified.inspect}, creator: #{@creator.inspect}, modifier: #{@modifier.inspect}, txn:"\
+      " #{@txn.inspect}, ref: #{@ref.inspect}, stage: #{@stage.inspect}, platform:"\
+      " #{@platform.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/txn_reports_response.rb

@@ -0,0 +1,185 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # TxnReportsResponse Model.
+  class TxnReportsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of this resource.
+    # @return [String]
+    attr_accessor :id
+
+    # The date and time at which this resource was created. The format should be
+    # YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :created
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :modified
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [Object]
+    attr_accessor :creator
+
+    # The identifier of the Login that last modified this resource.
+    # @return [String]
+    attr_accessor :modifier
+
+    # The identifier of the Transaction resource associated with this txnReports
+    # resource.
+    # @return [String]
+    attr_accessor :txn
+
+    # The type of interchange used by the Transaction.
+    # @return [String]
+    attr_accessor :interchange_type
+
+    # The name of the bank that issued the card used in the Transaction.
+    # @return [String]
+    attr_accessor :issuing_bank
+
+    # If the fee charged by the Processor was a flat rate, then this field
+    # specifies its absolute amount. 
+    # This field is specified as an integer in cents.
+    # @return [Integer]
+    attr_accessor :flat_rate_fee
+
+    # If the fee charged by the Processor was a percentage of the Transaction
+    # value, then this field specifies the percentage, expressed in basis
+    # points. 
+    # For example, 25.3% is expressed as '2530'.
+    # @return [Integer]
+    attr_accessor :percent_fee
+
+    # This is the total amount charged in interchange fees. 
+    # This field is specified as an integer in cents.
+    # @return [Integer]
+    attr_accessor :fee_total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['created'] = 'created'
+      @_hash['modified'] = 'modified'
+      @_hash['creator'] = 'creator'
+      @_hash['modifier'] = 'modifier'
+      @_hash['txn'] = 'txn'
+      @_hash['interchange_type'] = 'interchangeType'
+      @_hash['issuing_bank'] = 'issuingBank'
+      @_hash['flat_rate_fee'] = 'flatRateFee'
+      @_hash['percent_fee'] = 'percentFee'
+      @_hash['fee_total'] = 'feeTotal'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created
+        modified
+        creator
+        modifier
+        txn
+        interchange_type
+        issuing_bank
+        flat_rate_fee
+        percent_fee
+        fee_total
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, created = SKIP, modified = SKIP, creator = SKIP,
+                   modifier = SKIP, txn = SKIP, interchange_type = SKIP,
+                   issuing_bank = SKIP, flat_rate_fee = SKIP,
+                   percent_fee = SKIP, fee_total = SKIP)
+      @id = id unless id == SKIP
+      @created = created unless created == SKIP
+      @modified = modified unless modified == SKIP
+      @creator = creator unless creator == SKIP
+      @modifier = modifier unless modifier == SKIP
+      @txn = txn unless txn == SKIP
+      @interchange_type = interchange_type unless interchange_type == SKIP
+      @issuing_bank = issuing_bank unless issuing_bank == SKIP
+      @flat_rate_fee = flat_rate_fee unless flat_rate_fee == SKIP
+      @percent_fee = percent_fee unless percent_fee == SKIP
+      @fee_total = fee_total unless fee_total == 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
+      created = hash.key?('created') ? hash['created'] : SKIP
+      modified = hash.key?('modified') ? hash['modified'] : SKIP
+      creator = hash.key?('creator') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:TxnReportsResponseCreator), hash['creator']
+      ) : SKIP
+      modifier = hash.key?('modifier') ? hash['modifier'] : SKIP
+      txn = hash.key?('txn') ? hash['txn'] : SKIP
+      interchange_type =
+        hash.key?('interchangeType') ? hash['interchangeType'] : SKIP
+      issuing_bank = hash.key?('issuingBank') ? hash['issuingBank'] : SKIP
+      flat_rate_fee = hash.key?('flatRateFee') ? hash['flatRateFee'] : SKIP
+      percent_fee = hash.key?('percentFee') ? hash['percentFee'] : SKIP
+      fee_total = hash.key?('feeTotal') ? hash['feeTotal'] : SKIP
+
+      # Create object from extracted values.
+      TxnReportsResponse.new(id,
+                             created,
+                             modified,
+                             creator,
+                             modifier,
+                             txn,
+                             interchange_type,
+                             issuing_bank,
+                             flat_rate_fee,
+                             percent_fee,
+                             fee_total)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TxnReportsResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, created: #{@created}, modified: #{@modified}, creator:"\
+      " #{@creator}, modifier: #{@modifier}, txn: #{@txn}, interchange_type: #{@interchange_type},"\
+      " issuing_bank: #{@issuing_bank}, flat_rate_fee: #{@flat_rate_fee}, percent_fee:"\
+      " #{@percent_fee}, fee_total: #{@fee_total}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, created: #{@created.inspect}, modified:"\
+      " #{@modified.inspect}, creator: #{@creator.inspect}, modifier: #{@modifier.inspect}, txn:"\
+      " #{@txn.inspect}, interchange_type: #{@interchange_type.inspect}, issuing_bank:"\
+      " #{@issuing_bank.inspect}, flat_rate_fee: #{@flat_rate_fee.inspect}, percent_fee:"\
+      " #{@percent_fee.inspect}, fee_total: #{@fee_total.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/txn_result_type_enum.rb

@@ -0,0 +1,44 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # txnResultType.
+  class TxnResultTypeEnum
+    TXN_RESULT_TYPE_ENUM = [
+      # A general type of result.
+      GENERALRESULT = 1,
+
+      # Fraud prevention alert.
+      FRAUDPREVENTIONALERT = 2,
+
+      # Processor error.
+      PROCESSORERROR = 3,
+
+      # CVV matching alert.
+      CVVMATCHINGALERT = 4,
+
+      # AVS check alert.
+      AVSCHECKALERT = 5,
+
+      # AAVS check alert.
+      AAVSCHECKALERT = 6,
+
+      # Network error.
+      NETWORKERROR = 7,
+
+      # 3DS check alert.
+      ENUM_8 = 8,
+
+      # Pinless Debit conversion failed attempt.
+      PINLESSDEBITCONVERSIONERROR = 9
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TXN_RESULT_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/txn_results_code_enum.rb

@@ -0,0 +1,135 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # txnResultsCode.
+  class TxnResultsCodeEnum
+    TXN_RESULTS_CODE_ENUM = [
+      # Transaction approved.
+      APPROVED = 0,
+
+      # Partially approved. The processor has only approved a portion of the
+      # total transaction amount.
+      PARTIALLYAPPROVED = 1,
+
+      # Declined. The processor has declined the Transaction.
+      DECLINED = 2,
+
+      # Verification successful, values provided matched.
+      MATCH = 3,
+
+      # Verification unsuccessful, values provided did not match.
+      NOMATCH = 4,
+
+      # The ZIP code in the Transaction data does not match the customer details
+      # held by the card issuer.
+      ZIPNOMATCH = 5,
+
+      # The address in the Transaction data does not match the customer details
+      # held by the card issuer.
+      ADDRESSNOMATCH = 6,
+
+      # The name in the Transaction data does not match the customer details
+      # held by the card issuer.
+      NAMENOMATCH = 7,
+
+      # The name and phone number in the Transaction data do not match the
+      # details held by the card issuer.
+      NAMEPHONENOMATCH = 8,
+
+      # The name and email address in the Transaction data do not match the
+      # customer details held by the card issuer.
+      NAMEEMAILNOMATCH = 9,
+
+      # The phone number in the Transaction data does not match the customer
+      # details held by the card issuer.
+      PHONENOMATCH = 10,
+
+      # The phone number and email address in the Transaction data do not match
+      # the customer details held by the card issuer.
+      PHONEEMAILNOMATCH = 11,
+
+      # The email address in the Transaction data does not match the customer
+      # details held by the card issuer.
+      EMAILNOMATCH = 12,
+
+      # The customer name could not be found in the Transaction data.
+      NAMEUNAVAILABLE = 13,
+
+      # The customer name and phone number were not found in the Transaction
+      # data.
+      NAMEPHONEUNAVAILABLE = 14,
+
+      # The customer name and email address were not found in the Transaction
+      # data.
+      NAMEEMAILUNAVAILABLE = 15,
+
+      # The customer phone number was not found in the Transaction data.
+      PHONEUNAVAILABLE = 16,
+
+      # The customer phone number and email address were not found in the
+      # Transaction data.
+      PHONEEMAILUNAVAILABLE = 17,
+
+      # The customer email address was not found in the Transaction data.
+      EMAILUNAVAILABLE = 18,
+
+      # Information about the customer was not found in the Transaction data.
+      UNAVAILABLE = 19,
+
+      # Non-sufficient funds. The customer did not have sufficient credit or
+      # balance to cover the Transaction.
+      NSF = 20,
+
+      # The account in the Transaction data is not valid.
+      BADACCOUNT = 21,
+
+      # The account is unauthorized.
+      UNAUTHORIZED = 22,
+
+      # General error.
+      GENERAL = 23,
+
+      # The ZIP code in the Transaction data was not verified.
+      ZIPNOTVERIFIED = 24,
+
+      # The ZIP code and the Address in the Transaction data were not verified.
+      ZIPADDRESSNOTVERIFIED = 25,
+
+      # The Address in the Transaction data was not verified.
+      ADDRESSNOTVERIFIED = 26,
+
+      # Txn did not fail but was not captured.
+      WARNING = 27,
+
+      # 3DS authentication passed.
+      ENUM_28 = 28,
+
+      # 3DS authentication is invalid.
+      ENUM_29 = 29,
+
+      # 3DS authentication failed.
+      ENUM_30 = 30,
+
+      # 3DS authentication was not validated.
+      ENUM_31 = 31,
+
+      # 3DS authentication passed without liability shift.
+      ENUM_32 = 32,
+
+      # Transaction processing timed out.
+      TIMEOUT = 33,
+
+      # Transaction cancelled.
+      CANCELLED = 34
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TXN_RESULTS_CODE_ENUM.include?(value)
+    end
+  end
+end