payrix-api-sdk 1.0.0

data/lib/payrix/models/pending_entries_response_item.rb

@@ -0,0 +1,101 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # PendingEntriesResponseItem Model.
+  class PendingEntriesResponseItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The data object that the API returns for this request.
+    # @return [Array[PendingEntriesResponse]]
+    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 << (PendingEntriesResponse.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.
+      PendingEntriesResponseItem.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/pending_entries_response_result.rb

@@ -0,0 +1,62 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # PendingEntriesResponseResult Model.
+  class PendingEntriesResponseResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PendingEntriesResponseItem]
+    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 = PendingEntriesResponseItem.from_hash(hash['response']) if hash['response']
+
+      # Create object from extracted values.
+      PendingEntriesResponseResult.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/pending_entry_event_enum.rb

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

data/lib/payrix/models/pending_enum.rb

@@ -0,0 +1,23 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # Pending.
+  class PendingEnum
+    PENDING_ENUM = [
+      # The resource is not marked as pending.
+      NOTPENDING = 0,
+
+      # The resource is marked as pending.
+      PENDING = 1
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PENDING_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/pending_risk_check_enum.rb

@@ -0,0 +1,29 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # PendingRiskCheck.
+  class PendingRiskCheckEnum
+    PENDING_RISK_CHECK_ENUM = [
+      # The risk check is pending.
+      PENDING = 'pending'.freeze,
+
+      # The risk check was successful.
+      SUCCESSFUL = 'successful'.freeze,
+
+      # The risk check failed.
+      FAILED = 'failed'.freeze,
+
+      # The risk check requires manual review.
+      MANUAL = 'manual'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PENDING_RISK_CHECK_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/period_enum.rb

@@ -0,0 +1,38 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # Period.
+  class PeriodEnum
+    PERIOD_ENUM = [
+      # Days. The basic value for the date range is set in days.
+      DAYS = 'days'.freeze,
+
+      # Weeks. The basic value for the date range is set in weeks.
+      WEEKS = 'weeks'.freeze,
+
+      # Months. The basic value for the date range is set in months.
+      MONTHS = 'months'.freeze,
+
+      # Years. The basic value for the date range is set in years.
+      YEARS = 'years'.freeze,
+
+      # Seconds. The basic value for the date range is set in seconds.
+      SECONDS = 'seconds'.freeze,
+
+      # Minutes. The basic value for the date range is set in minutes.
+      MINUTES = 'minutes'.freeze,
+
+      # Hours. The basic value for the date range is set in hours.
+      HOURS = 'hours'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PERIOD_ENUM.include?(value)
+    end
+  end
+end

data/lib/payrix/models/pin_entry_capability_enum.rb

@@ -0,0 +1,29 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # PinEntryCapability.
+  class PinEntryCapabilityEnum
+    PIN_ENTRY_CAPABILITY_ENUM = [
+      # Unknown PIN Entry Capability.
+      UNKNOWN = 'unknown'.freeze,
+
+      # Terminal can accept PINs.
+      CAPABLE = 'capable'.freeze,
+
+      # Terminal cannot accept entry of PINs.
+      NOTCAPABLE = 'notCapable'.freeze,
+
+      # Terminal PIN Pad is down.
+      PINPADDOWN = 'pinPadDown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PIN_ENTRY_CAPABILITY_ENUM.include?(value)
+    end
+  end
+end