payrix-api-sdk 1.0.0

data/lib/payrix/models/entity_returns_response.rb

@@ -0,0 +1,399 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # EntityReturnsResponse Model.
+  class EntityReturnsResponse < 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 Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :login
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :entity
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :payment
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :txn
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :disbursement
+
+    # Describes the action code related to the return.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `unknown` - **Unknown reason**
+    # - `nsf` - **Non-sufficient funds**
+    # - `badAccount` - **Bad Account Info**
+    # - `unauthorized` - **Unauthorized Transaction**
+    # </details>
+    # @return [ActionCodeEnum]
+    attr_accessor :action_code
+
+    # The code that is received from the platform.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `R01` - **R01.** Insufficient funds in account.
+    # - `R02` - **R02.** Account is closed.
+    # - `R03` - **R03.** No account on file.
+    # - `R04` - **R04.** Invalid account number.
+    # - `R05` - **R05.** Unauthorized debit to consumer account.
+    # - `R06` - **R06.** Returned at request of ODFI.
+    # - `R07` - **R07.** Authorization revoked by customer.
+    # - `R08` - **R08.** Payment stopped.
+    # - `R09` - **R09.** Insufficient collected funds in account being charged
+    # - `R10` - **R10.** Customer advises not Authorized, notice not provided,
+    # improper source document, or amount of entry not accurately obtained from
+    # source document.
+    # - `R11` - **R11.** Check truncation return.
+    # - `R12` - **R12.** Account sold to another financial institution.
+    # - `R13` - **R13.** Invalid ACH routing number.
+    # - `R14` - **R14.** Representative payee is deceased or cannot continue in
+    # that capacity.
+    # - `R15` - **R15.** Beneficiary or account holder other than representative
+    # payee deceased.
+    # - `R16` - **R16.** Account funds have been frozen.
+    # - `R17` - **R17.** Item returned because of invalid data; refer to addenda
+    # for information.
+    # - `R18` - **R18.** Improper effective date.
+    # - `R19` - **R19.** Amount error.
+    # - `R20` - **R20.** Account does not allow ACH transactions or limit for
+    # transactions has been exceeded.
+    # - `R21` - **R21.** Invalid company identification.
+    # - `R22` - **R22.** Invalid individual ID.
+    # - `R23` - **R23.** Credit entry refused by receiver.
+    # - `R24` - **R24.** Duplicate entry.
+    # - `R25` - **R25.** Addenda record error.
+    # - `R26` - **R26.** Mandatory field error.
+    # - `R27` - **R27.** Trace number error.
+    # - `R28` - **R28.** Routing/transit number check digit error.
+    # - `R29` - **R29.** Corporate customer advised not authorized.
+    # - `R30` - **R30.** RDFI not participant in check truncation program.
+    # - `R31` - **R31.** Permissible return entry.
+    # - `R32` - **R32.** RDFI non-settlement.
+    # - `R33` - **R33.** Return of item.
+    # - `R34` - **R34.** Limited participation ODFI.
+    # - `R35` - **R35.** Return of improper debit entry.
+    # - `R36` - **R36.** Return of improper credit entry.
+    # - `R37` - **R37.** Source document presented for payment.
+    # - `R38` - **R38.** Stop payment on source document.
+    # - `R39` - **R39.** Improper source document.
+    # - `R40` - **R40.** Return of item by government agency.
+    # - `R41` - **R41.** Invalid Transaction Code.
+    # - `R42` - **R42.** Routing/transit number check digit error.
+    # - `R43` - **R43.** Invalid account number.
+    # - `R44` - **R44.** Invalid individual ID.
+    # - `R45` - **R45.** Invalid individual name or company name.
+    # - `R46` - **R46.** Invalid representative payee indicator code.
+    # - `R47` - **R47.** Duplicate enrollment.
+    # - `R50` - **R50.** State law affecting RCK acceptance.
+    # - `R51` - **R51.** Item is ineligible, notice not provided, signature not
+    # genuine, or original item altered for adjustment entry.
+    # - `R52` - **R52.** Stop payment on item.
+    # - `R53` - **R53.** Item and ACH entry presented for payment.
+    # - `R61` - **R61.** Misrouted return - RDFI for original entry has placed
+    # incorrect routing/transit number in RDFI identification field.
+    # - `R62` - **R62.** Incorrect trace number.
+    # - `R63` - **R63.** Incorrect dollar amount.
+    # - `R64` - **R64.** Incorrect individual identification.
+    # - `R65` - **R65.** Incorrect transaction code.
+    # - `R66` - **R66.** Incorrect company identification.
+    # - `R67` - **R67.** Duplicate return.
+    # - `R68` - **R68.** Untimely return - return was not sent within the
+    # established timeframe.
+    # - `R69` - **R69.** Field errors.
+    # - `R70` - **R70.** Permissible return entry not accepted.
+    # - `R71` - **R71.** Misrouted dishonored return -incorrect routing/transit
+    # number in RDFI identification field.
+    # - `R72` - **R72.** Untimely return - dishonored return was not sent within
+    # the established timeframe.
+    # - `R73` - **R73.** Timely original return - RDFI certifies the original
+    # return entry was sent within established timeframe for original returns.
+    # - `R74` - **R74.** Corrected return - RDFI is correcting a previous return
+    # entry that was dishonored because it contained incomplete or incorrect
+    # information.
+    # - `R75` - **R75.** Original return not a duplicate.
+    # - `R76` - **R76.** No errors found.
+    # - `R80` - **R80.** Cross-border payment coding error
+    # - `R81` - **R81.** Non-participant in cross-border program.
+    # - `R82` - **R82.** Invalid foreign RDFI identification.
+    # - `R83` - **R83.** Foreign RDFI unable to settle.
+    # - `R84` - **R84.** Cross-border entry not processed by originating gateway
+    # operator.
+    # - `R94` - **R94.** Administrative return item was processed and
+    # resubmitted as a photocopy.
+    # - `R95` - **R95.** Administrative return item was processed and
+    # resubmitted as a MICR-Split.
+    # - `R97` - **R97.** Administrative return item was processed and
+    # resubmitted with corrected dollar amount.
+    # - `R98` - **R98.** Indicates a return PAC (pre-authorized check); RDFI
+    # provides a text reason and indicated a new account number on the PAC
+    # itself.
+    # - `R99` - **R99.** Indicates a return PAC (pre-authorized check); RDFI
+    # provides a text reason on the PAC itself for which there is no equivalent
+    # return reason code.
+    # - `C01` - **C01.** Incorrect DFI Account Number.
+    # - `C02` - **C02.** Incorrect Transit/Routing Number.
+    # - `C03` - **C03.** Incorrect Transit/Routing Number and Incorrect DFI
+    # Account Number.
+    # - `C04` - **C04.** Incorrect Individual Name.
+    # - `C05` - **C05.** Incorrect Transaction Code.
+    # - `C06` - **C06.** Incorrect DFI Account Number and Incorrect Transaction
+    # Code.
+    # - `C07` - **C07.** Incorrect Transit/Routing Number, Incorrect DFI Account
+    # Number, and Incorrect Transaction Code.
+    # - `C08` - **C08.** Reserved.
+    # - `C09` - **C09.** Incorrect Individual Identification Number.
+    # - `C10` - **C10.** Incorrect Company Name.
+    # - `C11` - **C11.** Incorrect Company Identification.
+    # - `C12` - **C12.** Incorrect Company Name and Company Identification.
+    # - `C13` - **C13.** Addenda Format Error.
+    # - `C61` - **C61.** Misrouted Notification of Change.
+    # - `C62` - **C62.** Incorrect Trace Number.
+    # - `C63` - **C63.** Incorrect Company Identification Number.
+    # - `C64` - **C64.** Incorrect Individual Identification Number.
+    # - `C65` - **C65.** Incorrectly Formatted Corrected Data.
+    # - `C66` - **C66.** Incorrect Discretionary Data.
+    # - `C67` - **C67.** Routing Number Not From Original Entry Detail Record.
+    # - `C68` - **C68.** DFI Account Number Not From Original Entry Detail
+    # Record.
+    # - `C69` - **C69.** Incorrect Transaction Code.
+    # - `R900-07` - **R900-07.** Institution ID Invalid.
+    # - `R900-08` - **R900-08.** Account Number Invalid.
+    # - `R900-16` - **R900-16.** Institution ID for Return Invalid.
+    # - `R900-17` - **R900-17.** Account Number for Return Invalid.
+    # - `R900-D2` - **R900-D2.** Destination Institute is Not Defined on FIF.
+    # - `R900-E1` - **R900-E1.** Destination Account Number Invalid.
+    # - `R900-L2` - **R900-L2.** Institution for Return Not Defined on FIF.
+    # - `R900-L3` - **R900-L3.** Institution for Return Cross Reference Invalid.
+    # - `R900-M1` - **R900-M1.** Account for Return Invalid.
+    # - `R901` - **R901.** NFS (Debit Only).
+    # - `R902` - **R902.** Cannot Trace.
+    # - `R903` - **R903.** Payment Stopped/Recalled.
+    # - `R904` - **R904.** Post/Stale Dated.
+    # - `R905` - **R905.** Account Closed.
+    # - `R907` - **R907.** No Debit Allowed.
+    # - `R908` - **R908.** Funds Not Cleared.
+    # - `R909` - **R909.** Currency/Account Mismatch.
+    # - `R910` - **R910.** Payor/Payee Deceased.
+    # - `R911` - **R911.** Account Frozen.
+    # - `R912` - **R912.** Invalid/Incorrect Account Number.
+    # - `R914` - **R914.** Incorrect Payor/Payee Name.
+    # - `R915` - **R915.** PAD No Agreement Existed - Business/Personal.
+    # - `R916` - **R916.** PAD Not According to Agreement - Personal.
+    # - `R917` - **R917.** PAD Agreement Revoked - Personal.
+    # - `R918` - **R918.** PAD No Confirmation/Pre-Notification - Personal.
+    # - `R919` - **R919.** PAD Not According to Agreement - Business.
+    # - `R920` - **R920.** PAD Agreement Revoked - Business.
+    # - `R921` - **R921.** PAD No Confirmation/Pre-Notification - Business.
+    # - `R922` - **R922.** Customer Initiated Return - CREDIT only.
+    # - `R990` - **R990.** Institution in Default.
+    # @return [String]
+    attr_accessor :code
+
+    # The message that is received from the platform.
+    # @return [String]
+    attr_accessor :message
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [InactiveEnum]
+    attr_accessor :inactive
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [FrozenEnum]
+    attr_accessor :frozen
+
+    # 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['login'] = 'login'
+      @_hash['entity'] = 'entity'
+      @_hash['payment'] = 'payment'
+      @_hash['txn'] = 'txn'
+      @_hash['disbursement'] = 'disbursement'
+      @_hash['action_code'] = 'actionCode'
+      @_hash['code'] = 'code'
+      @_hash['message'] = 'message'
+      @_hash['inactive'] = 'inactive'
+      @_hash['frozen'] = 'frozen'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created
+        modified
+        creator
+        modifier
+        login
+        entity
+        payment
+        txn
+        disbursement
+        action_code
+        code
+        message
+        inactive
+        frozen
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, created = SKIP, modified = SKIP, creator = SKIP,
+                   modifier = SKIP, login = SKIP, entity = SKIP, payment = SKIP,
+                   txn = SKIP, disbursement = SKIP, action_code = SKIP,
+                   code = SKIP, message = SKIP, inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN)
+      @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
+      @login = login unless login == SKIP
+      @entity = entity unless entity == SKIP
+      @payment = payment unless payment == SKIP
+      @txn = txn unless txn == SKIP
+      @disbursement = disbursement unless disbursement == SKIP
+      @action_code = action_code unless action_code == SKIP
+      @code = code unless code == SKIP
+      @message = message unless message == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @frozen = frozen unless frozen == 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(:EntityReturnsResponseCreator), hash['creator']
+      ) : SKIP
+      modifier = hash.key?('modifier') ? hash['modifier'] : SKIP
+      login = hash.key?('login') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EntityReturnsResponseLogin), hash['login']
+      ) : SKIP
+      entity = hash.key?('entity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EntityReturnsResponseEntity), hash['entity']
+      ) : SKIP
+      payment = hash.key?('payment') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EntityReturnsResponsePayment), hash['payment']
+      ) : SKIP
+      txn = hash.key?('txn') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EntityReturnsResponseTxn), hash['txn']
+      ) : SKIP
+      disbursement = hash.key?('disbursement') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EntityReturnsResponseDisbursement), hash['disbursement']
+      ) : SKIP
+      action_code = hash.key?('actionCode') ? hash['actionCode'] : SKIP
+      code = hash.key?('code') ? hash['code'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+
+      # Create object from extracted values.
+      EntityReturnsResponse.new(id,
+                                created,
+                                modified,
+                                creator,
+                                modifier,
+                                login,
+                                entity,
+                                payment,
+                                txn,
+                                disbursement,
+                                action_code,
+                                code,
+                                message,
+                                inactive,
+                                frozen)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [EntityReturnsResponse | 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}, login: #{@login}, entity: #{@entity}, payment:"\
+      " #{@payment}, txn: #{@txn}, disbursement: #{@disbursement}, action_code: #{@action_code},"\
+      " code: #{@code}, message: #{@message}, inactive: #{@inactive}, frozen: #{@frozen}>"
+    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}, login:"\
+      " #{@login.inspect}, entity: #{@entity.inspect}, payment: #{@payment.inspect}, txn:"\
+      " #{@txn.inspect}, disbursement: #{@disbursement.inspect}, action_code:"\
+      " #{@action_code.inspect}, code: #{@code.inspect}, message: #{@message.inspect}, inactive:"\
+      " #{@inactive.inspect}, frozen: #{@frozen.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/entity_returns_response_item.rb

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

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