payrix-api-sdk 1.0.0

data/lib/payrix/models/entries_response_item.rb

@@ -0,0 +1,101 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # EntriesResponseItem Model.
+  class EntriesResponseItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The data object that the API returns for this request.
+    # @return [Array[EntriesResponse]]
+    attr_accessor :data
+
+    # An object describing the response, including the request ID and pagination
+    # indicators.
+    # @return [Details]
+    attr_accessor :details
+
+    # An array of zero or more errors that occurred when the API processed the
+    # request.
+    # @return [Array[ErrorItem]]
+    attr_accessor :errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['details'] = 'details'
+      @_hash['errors'] = 'errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+        details
+        errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = SKIP, details = SKIP, errors = SKIP)
+      @data = data unless data == SKIP
+      @details = details unless details == SKIP
+      @errors = errors unless errors == 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.
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (EntriesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('data')
+      details = Details.from_hash(hash['details']) if hash['details']
+      # Parameter is an array, so we need to iterate through it
+      errors = nil
+      unless hash['errors'].nil?
+        errors = []
+        hash['errors'].each do |structure|
+          errors << (ErrorItem.from_hash(structure) if structure)
+        end
+      end
+
+      errors = SKIP unless hash.key?('errors')
+
+      # Create object from extracted values.
+      EntriesResponseItem.new(data,
+                              details,
+                              errors)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}, details: #{@details}, errors: #{@errors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}, details: #{@details.inspect}, errors:"\
+      " #{@errors.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/entries_response_result.rb

@@ -0,0 +1,62 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # EntriesResponseResult Model.
+  class EntriesResponseResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [EntriesResponseItem]
+    attr_accessor :response
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response'] = 'response'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(response = SKIP)
+      @response = response unless response == 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.
+      response = EntriesResponseItem.from_hash(hash['response']) if hash['response']
+
+      # Create object from extracted values.
+      EntriesResponseResult.new(response)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response: #{@response}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response: #{@response.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/entry_event_enum.rb

@@ -0,0 +1,397 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # entryEvent.
+  class EntryEventEnum
+    ENTRY_EVENT_ENUM = [
+      # The Entry is triggered by a daily event.
+      DAYS = 1,
+
+      # The Entry is triggered by a weekly event.
+      WEEKS = 2,
+
+      # The Entry is triggered by a monthly event.
+      MONTHS = 3,
+
+      # The Entry is triggered by an annual event.
+      YEARS = 4,
+
+      # The Entry is triggered by a one-off event.
+      SINGLE = 5,
+
+      # The Entry is triggered when a transaction has been authorized.
+      AUTH = 6,
+
+      # The Entry is triggered when a transaction has been captured.
+      CAPTURE = 7,
+
+      # The Entry is triggered when a refund transaction is processed.
+      REFUND = 8,
+
+      # The Entry is triggered when a Merchant is boarded.
+      BOARD = 9,
+
+      # The Entry is triggered when a payout is processed.
+      PAYOUT = 10,
+
+      # The Entry is triggered when a card chargeback occurs.
+      CHARGEBACK = 11,
+
+      # The Entry is triggered when an overdraft usage charge from a bank is
+      # levied.
+      OVERDRAFT = 12,
+
+      # The Entry is triggered when interchange Fees are assessed for the
+      # Transactions of this Merchant.
+      INTERCHANGE = 13,
+
+      # The Entry is triggered when the Transactions of this Merchant are
+      # processed by a payment processor.
+      PROCESSOR = 14,
+
+      # The Entry is triggered when an automated clearing house failure occurs.
+      ACHFAIL = 15,
+
+      # The Entry is triggered when a bank account is verified.
+      ACCOUNT = 16,
+
+      # The Entry is triggered by a transaction's fraud Score.
+      SIFT = 17,
+
+      # The Entry is triggered when there's an adjustment.
+      ADJUSTMENT = 18,
+
+      # The Entry is triggered by a retrieval request chargeback.
+      RETRIEVAL = 19,
+
+      # The Entry is triggered by an arbitration chargeback.
+      ARBITRATION = 20,
+
+      # The Entry is triggered by an eCheck sale transaction.
+      ECSALE = 21,
+
+      # The Entry is triggered by an eCheck refund.
+      ECREFUND = 22,
+
+      # The Entry is triggered by an eCheck return.
+      ECRETURN = 23,
+
+      # The Entry triggers when a transaction has been settled.
+      SETTLEMENT = 24,
+
+      # The Entry is triggered when there's been a Misuse of authorization.
+      MISUSE = 25,
+
+      # The Entry is triggered by a profit sharing entry event.
+      PROFITSHARE = 26,
+
+      # The Entry is triggered when a transaction is unauthorized.
+      UNAUTH = 27,
+
+      # The Entry is triggered by a disbursement NOC (Notification of change).
+      ACHNOC = 28,
+
+      # The Entry is triggered by an echeck transaction NOC (Notification of
+      # change).
+      ECNOC = 29,
+
+      # The Entry is triggered by an echeck transaction failed.
+      ECFAIL = 30,
+
+      # The Entry is triggered by an eCheck transaction NSF (Non-sufficient
+      # funds) return.
+      ECNSF = 31,
+
+      # This Entry is triggered by a currency conversion.
+      CURRENCYCONVERSION = 32,
+
+      # This Entry is triggered by a terminal transaction.
+      TERMINALTXN = 33,
+
+      # This Entry is triggered by a payout that has been reversed.
+      REVERSEPAYOUT = 34,
+
+      # This Entry is triggered by a payout that has been partially reversed.
+      PARTIALREVERSEPAYOUT = 35,
+
+      # This Entry is triggered by a payment check for Account Updater.
+      PAYMENTCHECK = 43,
+
+      # This Entry is triggered by a payment update for Account Updater.
+      PAYMENTUPDATE = 44,
+
+      # This Entry is triggered by a payment group check for Account Updater.
+      PAYMENTGROUPCHECK = 45,
+
+      # This Entry is triggered by a payment group update for Account Updater.
+      PAYMENTGROUPUPDATE = 46,
+
+      # This Entry is triggered by an entry refund.
+      ENTRYREFUND = 47,
+
+      # The payment of a statement.
+      STATEMENT = 51,
+
+      # Merchant fee upon creation.
+      MERCHANTCREATION = 52,
+
+      # Real-time business search.
+      REALTIMEBUSINESSSEARCH = 53,
+
+      # Real-time member search.
+      REALTIMEMEMBERSEARCH = 54,
+
+      # Mastercard match.
+      MASTERCARDMATCH = 55,
+
+      # Business instant ID.
+      BUSINESSINSTANTID = 56,
+
+      # Consumer instant ID.
+      CONSUMERINSTANTID = 57,
+
+      # Threat Metrix.
+      THREATMETRIX = 58,
+
+      # Legit Script Register.
+      LEGITSCRIPTREGISTER = 59,
+
+      # Equifax consumer report.
+      EQUIFAXCONSUMERREPORT = 60,
+
+      # Guide Star.
+      GUIDESTAR = 61,
+
+      # internal decision V2.
+      PAYLOADATTRIBUTE = 62,
+
+      # Tin Check.
+      TINCHECK = 63,
+
+      # Equifax commercial report.
+      EQUIFAXCOMMERCIALREPORT = 64,
+
+      # Legit Script Check Merchant.
+      LEGITSCRIPTCHECKMERCHANT = 65,
+
+      # Plaid.
+      PLAID = 66,
+
+      # the reversal of a statement.
+      STATEMENTREVERSAL = 67,
+
+      # GIACT call made to verify creator Echeck bank account.
+      GIACTECHECK = 68,
+
+      # Giact calls to verify merchant settlement account.
+      GIACTBANKACCOUNT = 69,
+
+      # process decision fee after board.
+      BOARDDECISION = 70,
+
+      # Transaction going through Risk decision.
+      TXNRISKDECISION = 71,
+
+      # External fees.
+      FANF = 72,
+
+      # External fees.
+      MCLOCATION = 73,
+
+      # External fees.
+      VISAINTEGRITY = 74,
+
+      # External fees.
+      SAFERPAYMENTSBASIC = 75,
+
+      # External fees.
+      SAFERPAYMENTSMANAGED = 76,
+
+      # External fees.
+      SAFERPAYMENTSPCINONVALIDATION = 77,
+
+      # External fees.
+      OMNITOKENSVOLUME = 78,
+
+      # Payout return.
+      PAYOUTRETURN = 79,
+
+      # Partial payout return.
+      PAYOUTPARTIALRETURN = 80,
+
+      # Revenue sharing.
+      REVSHARE = 81,
+
+      # Card settlement.
+      CARDSETTLEMENT = 82,
+
+      # E-Check settlement.
+      ECHECKSETTLEMENT = 83,
+
+      # Revenue sharing for cards.
+      REVSHARECARD = 84,
+
+      # Revenue sharing for e-checks.
+      REVSHAREECHECK = 85,
+
+      # Revenue sharing for DBM.
+      REVSHAREDBM = 86,
+
+      # Chargeback pre-arbitration.
+      PREARBITRATION = 87,
+
+      # Plaid Identity Mach.
+      PLAIDIDENTITYMACH = 88,
+
+      # transactions with Plaid Identity Mach.
+      TXNPLAIDIDENTITYMACH = 89,
+
+      # Plaid Get Identity.
+      PLAIDGETIDENTITY = 90,
+
+      # Transactions with Plaid Get Identity.
+      TXNPLAIDGETIDENTITY = 91,
+
+      # Plaid Get Auth.
+      PLAIDGETAUTH = 92,
+
+      # Transactions with Plaid Get Auth.
+      TXNPLAIDGETAUTH = 93,
+
+      # Chargeback reversal.
+      REVERSAL = 94,
+
+      # Chargeback representment.
+      REPRESENTMENT = 95,
+
+      # Omnitokens monthly fee.
+      OMNITOKENSMONTHLY = 96,
+
+      # Interchange retain pass-through refund.
+      ICRETAINPASSTHRUREFUND = 101,
+
+      # External fees.
+      VALUTECESSENTIALGIFT = 200,
+
+      # External fees.
+      VALUTECESSENTIALMONTHLYTXN = 201,
+
+      # External fees.
+      VALUTECDIGITALGIFTPLUSPACKAGE = 202,
+
+      # External fees.
+      VALUTECDIGITALGIFTPLUSPACKAGETXN = 203,
+
+      # External fees.
+      VALUTECLOYALTYPLUSPACKAGE = 204,
+
+      # External fees.
+      VALUTECLOYALTYPLUSPACKAGETXN = 205,
+
+      # External fees.
+      VALUTECTRANSACTIONFEE = 206,
+
+      # External fees.
+      VALUTECSETUPFEE = 207,
+
+      # External fees.
+      VALUTECGIFTACHPOOLING = 208,
+
+      # External fees.
+      VALUTECJUMPSTARTKIT = 209,
+
+      # External fees.
+      VALUTECLAUNCHBOXKIT = 210,
+
+      # External fees.
+      VALUTEC500CUSTOMCARDS = 211,
+
+      # External fees.
+      VALUTECMAINTENANCEFEE = 212,
+
+      # External fees.
+      VALUTECDIGITALGIFTPLUSPACKAGEME = 213,
+
+      # EFE External fees.
+      EFEMWCRESIDUALATELIO = 214,
+
+      # EFE External fees.
+      EFEMWCRESIDUALPARAFIN = 215,
+
+      # EFE External fees.
+      EFEMWCBILLING = 216,
+
+      # External fees.
+      FRAUDSIGHTCNPDECISION = 217,
+
+      # External fees.
+      FRAUDSIGHTCPDECISION = 218,
+
+      # External fees.
+      REVBOOSTEMBEDDEDTMSMONTHLY = 400,
+
+      # External fees.
+      REVBOOSTEMBEDDEDTMSPPT = 401,
+
+      # External fees.
+      TXNTHREATMETRIX = 402,
+
+      # External fees.
+      THREATMETRIXEMAILAGE = 403,
+
+      # External fees.
+      THREATMETRIXFRAUDPOINT = 404,
+
+      # External fees.
+      GIACTINQUIRY = 405,
+
+      # External fees.
+      GIACTTXNGAUTHENTICATE = 406,
+
+      # External fees.
+      TRULIOOIDV = 407,
+
+      # External fees.
+      TRULIOOAMLLDV = 408,
+
+      # External fees.
+      TRULIOOBUSINESSVERIFICATION = 409,
+
+      # External fees.
+      THREATMETRIXPHONEFINDER = 410,
+
+      # Risk-based tier fees.
+      TIERNONQUALIFIEDCOUNT = 601,
+
+      # Risk-based tier fees.
+      TIERQUALIFIEDCOUNT = 602,
+
+      # Risk-based tier fees.
+      TIERMIDQUALIFIEDCOUNT = 603,
+
+      # Risk-based tier fees.
+      TIERHIGHRISKCOUNT = 604,
+
+      # Risk-based tier fees.
+      TIERNONQUALIFIEDVOLUME = 605,
+
+      # Risk-based tier fees.
+      TIERQUALIFIEDVOLUME = 606,
+
+      # Risk-based tier fees.
+      TIERMIDQUALIFIEDVOLUME = 607,
+
+      # Risk-based tier fees.
+      TIERHIGHRISKVOLUME = 608
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ENTRY_EVENT_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/entry_mode_enum.rb

@@ -0,0 +1,59 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # entryMode.
+  class EntryModeEnum
+    ENTRY_MODE_ENUM = [
+      # Manually keyed entry.
+      KEYED = 1,
+
+      # Card swiped. Track 1 received.
+      TRACK1 = 2,
+
+      # Card swiped. Track 2 received.
+      TRACK2 = 3,
+
+      # Card swiped. Track 1 & 2 received.
+      BOTH = 4,
+
+      # Card dipped. EMV chip received.
+      EMV = 5,
+
+      # Contactless card read. Track or EMV data received.
+      CONTACTLESS = 6,
+
+      # Track Data from Card Swipe after EMV chip failure.
+      FALLBACKSWIPED = 7,
+
+      # Track Data from Manually keyed entry after EMV chip failure.
+      FALLBACKKEYED = 8,
+
+      # ApplePay read and cryptogram data received.
+      APPLEPAY = 9,
+
+      # Google Pay.
+      GOOGLEPAY = 10,
+
+      # Merchant created transaction.
+      MERCHANT = 11,
+
+      # Invoice payment.
+      INVOICE = 12,
+
+      # Merchant created transaction in payrix portal.
+      PAYRIXMERCHANT = 13,
+
+      # Invoice payment from payrix portal.
+      PAYRIXINVOICE = 14
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ENTRY_MODE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/entry_origin_platform_enum.rb

@@ -0,0 +1,50 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # entryOriginPlatform.
+  class EntryOriginPlatformEnum
+    ENTRY_ORIGIN_PLATFORM_ENUM = [
+      # Apple processor.
+      APPLE = 'APPLE'.freeze,
+
+      # The Elavon processor.
+      ELAVON = 'ELAVON'.freeze,
+
+      # First Data processor.
+      FIRSTDATA = 'FIRSTDATA'.freeze,
+
+      # Google processor.
+      GOOGLE = 'GOOGLE'.freeze,
+
+      # The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.
+      VANTIV = 'VANTIV'.freeze,
+
+      # The WorldPay (aka Vantiv) Core processor.
+      VCORE = 'VCORE'.freeze,
+
+      # The Wells Fargo ACH processor.
+      WELLSACH = 'WELLSACH'.freeze,
+
+      # The Wells Fargo Merchant Services processor.
+      WELLSFARGO = 'WELLSFARGO'.freeze,
+
+      # The WFSINGLE processor.
+      WFSINGLE = 'WFSINGLE'.freeze,
+
+      # The WORLDPAY processor.
+      WORLDPAY = 'WORLDPAY'.freeze,
+
+      # External funding with TD Bank Canada via the Operating Account.
+      TDBANKCA = 'TDBANKCA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ENTRY_ORIGIN_PLATFORM_ENUM.include?(value)
+    end
+  end
+end