payrix-api-sdk 1.0.0

data/lib/payrix/models/holds_response.rb

@@ -0,0 +1,482 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # HoldsResponse Model.
+  class HoldsResponse < 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 :txn
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :terminal_txn
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :account
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :verification
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :verification_ref
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :decision_action
+
+    # The action taken on the referenced Txn. Block, Hold, or Reserve it.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **NONE**
+    # - `1` - **Block.** Block the Transaction from proceeding. This returns an
+    # error.
+    # - `3` - **Hold.** Hold the Transaction. It will not be captured until it
+    # is manually released.
+    # - `4` - **Reserve** Reserve the Transaction. The funds for the transaction
+    # will not be released until the Transaction is manually reviewed.
+    # - `5` - **LIMIT** Block current activity.
+    # - `6` - **PASS** Passed decision(s).
+    # - `8` - **POSTREVIEWONLY** Passed decision(s).
+    # </details>
+    # @return [HoldActionEnum]
+    attr_accessor :action
+
+    # If this hold was released, this will contain the timestamp for when it was
+    # released. The format should be YYYY-MM-DD HH:MM:SS
+    # @return [String]
+    attr_accessor :released
+
+    # If this hold was reviewed, this will contain the timestamp for when it was
+    # reviewed. The format should be YYYY-MM-DD HH:MM:SS
+    # @return [String]
+    attr_accessor :reviewed
+
+    # 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
+
+    # The final action taken on the hold while it's been released.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `1` - **Holds released because the hold resource was approved.**
+    # - `2` - **Holds released because the hold resource was cancelled.**
+    # - `3` - **Holds released because the hold resource was refunded.**
+    # - `4` - **Holds released because the hold resource was failed.**
+    # - `5` - **Expired.**
+    # </details>
+    # @return [ReleaseActionEnum]
+    attr_accessor :release_action
+
+    # The timestamp when hold was considered to be delaying funding. The format
+    # should be YYYY-MM-DD HH:MM:SS.
+    # @return [String]
+    attr_accessor :delayed_funding_start_date
+
+    # The timestamp when hold stopped delaying funding, this might be due to the
+    # hold been released, cancelled or funded. The format should be YYYY-MM-DD
+    # HH:MM:SS.
+    # @return [String]
+    attr_accessor :delayed_funding_end_date
+
+    # The timestamp when hold stopped delaying funding, this might be due to the
+    # hold been released, cancelled or funded. The format should be YYYY-MM-DD
+    # HH:MM:SS.
+    # @return [Object]
+    attr_accessor :analyst
+
+    # The timestamp for the most recent update of the analyst field. The format
+    # should be YYYY-MM-DD HH:MM:SS.
+    # @return [String]
+    attr_accessor :claimed
+
+    # Field created to know the reason for why a hold was created.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `DS_MODEL_POLICY_RUN` - **DS_MODEL_POLICY_RUN**
+    # - `API_DECISION` - **API_DECISION**
+    # - `POLICY_RUN` - **POLICY_RUN**
+    # - `RISK_ALERT` - **RISK_ALERT**
+    # - `MANUAL` - **MANUAL**
+    # - `ERROR` - **ERROR**
+    # </details>
+    # @return [HoldSourceEnum]
+    attr_accessor :hold_source
+
+    # Reason id for why a hold was created.
+    # @return [String]
+    attr_accessor :hold_source_id
+
+    # It adds details to hold source.
+    # @return [String]
+    attr_accessor :hold_source_details
+
+    # ID of the division associated with this vendor
+    # @return [String]
+    attr_accessor :division
+
+    # ID of the division associated with this vendor
+    # @return [Array[MessageThreadsResponse]]
+    attr_accessor :message_thread
+
+    # ID of the division associated with this vendor
+    # @return [Array[NotesResponse]]
+    attr_accessor :notes
+
+    # ID of the division associated with this vendor
+    # @return [Array[ReserveEntriesResponse]]
+    attr_accessor :reserve_entries
+
+    # ID of the division associated with this vendor
+    # @return [ReservesResponse]
+    attr_accessor :reserve
+
+    # 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['txn'] = 'txn'
+      @_hash['terminal_txn'] = 'terminalTxn'
+      @_hash['account'] = 'account'
+      @_hash['verification'] = 'verification'
+      @_hash['verification_ref'] = 'verificationRef'
+      @_hash['decision_action'] = 'decisionAction'
+      @_hash['action'] = 'action'
+      @_hash['released'] = 'released'
+      @_hash['reviewed'] = 'reviewed'
+      @_hash['inactive'] = 'inactive'
+      @_hash['frozen'] = 'frozen'
+      @_hash['release_action'] = 'releaseAction'
+      @_hash['delayed_funding_start_date'] = 'delayedFundingStartDate'
+      @_hash['delayed_funding_end_date'] = 'delayedFundingEndDate'
+      @_hash['analyst'] = 'analyst'
+      @_hash['claimed'] = 'claimed'
+      @_hash['hold_source'] = 'holdSource'
+      @_hash['hold_source_id'] = 'holdSourceId'
+      @_hash['hold_source_details'] = 'holdSourceDetails'
+      @_hash['division'] = 'division'
+      @_hash['message_thread'] = 'messageThread'
+      @_hash['notes'] = 'notes'
+      @_hash['reserve_entries'] = 'reserveEntries'
+      @_hash['reserve'] = 'reserve'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created
+        modified
+        creator
+        modifier
+        login
+        entity
+        txn
+        terminal_txn
+        account
+        verification
+        verification_ref
+        decision_action
+        action
+        released
+        reviewed
+        inactive
+        frozen
+        release_action
+        delayed_funding_start_date
+        delayed_funding_end_date
+        analyst
+        claimed
+        hold_source
+        hold_source_id
+        hold_source_details
+        division
+        message_thread
+        notes
+        reserve_entries
+        reserve
+      ]
+    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, txn = SKIP,
+                   terminal_txn = SKIP, account = SKIP, verification = SKIP,
+                   verification_ref = SKIP, decision_action = SKIP,
+                   action = SKIP, released = SKIP, reviewed = SKIP,
+                   inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN, release_action = SKIP,
+                   delayed_funding_start_date = SKIP,
+                   delayed_funding_end_date = SKIP, analyst = SKIP,
+                   claimed = SKIP, hold_source = SKIP, hold_source_id = SKIP,
+                   hold_source_details = SKIP, division = SKIP,
+                   message_thread = SKIP, notes = SKIP, reserve_entries = SKIP,
+                   reserve = 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
+      @login = login unless login == SKIP
+      @entity = entity unless entity == SKIP
+      @txn = txn unless txn == SKIP
+      @terminal_txn = terminal_txn unless terminal_txn == SKIP
+      @account = account unless account == SKIP
+      @verification = verification unless verification == SKIP
+      @verification_ref = verification_ref unless verification_ref == SKIP
+      @decision_action = decision_action unless decision_action == SKIP
+      @action = action unless action == SKIP
+      @released = released unless released == SKIP
+      @reviewed = reviewed unless reviewed == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @frozen = frozen unless frozen == SKIP
+      @release_action = release_action unless release_action == SKIP
+      unless delayed_funding_start_date == SKIP
+        @delayed_funding_start_date =
+          delayed_funding_start_date
+      end
+      @delayed_funding_end_date = delayed_funding_end_date unless delayed_funding_end_date == SKIP
+      @analyst = analyst unless analyst == SKIP
+      @claimed = claimed unless claimed == SKIP
+      @hold_source = hold_source unless hold_source == SKIP
+      @hold_source_id = hold_source_id unless hold_source_id == SKIP
+      @hold_source_details = hold_source_details unless hold_source_details == SKIP
+      @division = division unless division == SKIP
+      @message_thread = message_thread unless message_thread == SKIP
+      @notes = notes unless notes == SKIP
+      @reserve_entries = reserve_entries unless reserve_entries == SKIP
+      @reserve = reserve unless reserve == 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(:HoldsResponseCreator), hash['creator']
+      ) : SKIP
+      modifier = hash.key?('modifier') ? hash['modifier'] : SKIP
+      login = hash.key?('login') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:HoldsResponseLogin), hash['login']
+      ) : SKIP
+      entity = hash.key?('entity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:HoldsResponseEntity), hash['entity']
+      ) : SKIP
+      txn = hash.key?('txn') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:HoldsResponseTxn), hash['txn']
+      ) : SKIP
+      terminal_txn = hash.key?('terminalTxn') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:HoldsResponseTerminalTxn), hash['terminalTxn']
+      ) : SKIP
+      account = hash.key?('account') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:HoldsResponseAccount), hash['account']
+      ) : SKIP
+      verification = hash.key?('verification') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:HoldsResponseVerification), hash['verification']
+      ) : SKIP
+      verification_ref = hash.key?('verificationRef') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:HoldsResponseVerificationRef), hash['verificationRef']
+      ) : SKIP
+      decision_action = hash.key?('decisionAction') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:HoldsResponseDecisionAction), hash['decisionAction']
+      ) : SKIP
+      action = hash.key?('action') ? hash['action'] : SKIP
+      released = hash.key?('released') ? hash['released'] : SKIP
+      reviewed = hash.key?('reviewed') ? hash['reviewed'] : SKIP
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+      release_action = hash.key?('releaseAction') ? hash['releaseAction'] : SKIP
+      delayed_funding_start_date =
+        hash.key?('delayedFundingStartDate') ? hash['delayedFundingStartDate'] : SKIP
+      delayed_funding_end_date =
+        hash.key?('delayedFundingEndDate') ? hash['delayedFundingEndDate'] : SKIP
+      analyst = hash.key?('analyst') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:HoldsResponseAnalyst), hash['analyst']
+      ) : SKIP
+      claimed = hash.key?('claimed') ? hash['claimed'] : SKIP
+      hold_source = hash.key?('holdSource') ? hash['holdSource'] : SKIP
+      hold_source_id = hash.key?('holdSourceId') ? hash['holdSourceId'] : SKIP
+      hold_source_details =
+        hash.key?('holdSourceDetails') ? hash['holdSourceDetails'] : SKIP
+      division = hash.key?('division') ? hash['division'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      message_thread = nil
+      unless hash['messageThread'].nil?
+        message_thread = []
+        hash['messageThread'].each do |structure|
+          message_thread << (MessageThreadsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      message_thread = SKIP unless hash.key?('messageThread')
+      # Parameter is an array, so we need to iterate through it
+      notes = nil
+      unless hash['notes'].nil?
+        notes = []
+        hash['notes'].each do |structure|
+          notes << (NotesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      notes = SKIP unless hash.key?('notes')
+      # Parameter is an array, so we need to iterate through it
+      reserve_entries = nil
+      unless hash['reserveEntries'].nil?
+        reserve_entries = []
+        hash['reserveEntries'].each do |structure|
+          reserve_entries << (ReserveEntriesResponse.from_hash(structure) if structure)
+        end
+      end
+
+      reserve_entries = SKIP unless hash.key?('reserveEntries')
+      reserve = ReservesResponse.from_hash(hash['reserve']) if hash['reserve']
+
+      # Create object from extracted values.
+      HoldsResponse.new(id,
+                        created,
+                        modified,
+                        creator,
+                        modifier,
+                        login,
+                        entity,
+                        txn,
+                        terminal_txn,
+                        account,
+                        verification,
+                        verification_ref,
+                        decision_action,
+                        action,
+                        released,
+                        reviewed,
+                        inactive,
+                        frozen,
+                        release_action,
+                        delayed_funding_start_date,
+                        delayed_funding_end_date,
+                        analyst,
+                        claimed,
+                        hold_source,
+                        hold_source_id,
+                        hold_source_details,
+                        division,
+                        message_thread,
+                        notes,
+                        reserve_entries,
+                        reserve)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [HoldsResponse | 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}, txn: #{@txn},"\
+      " terminal_txn: #{@terminal_txn}, account: #{@account}, verification: #{@verification},"\
+      " verification_ref: #{@verification_ref}, decision_action: #{@decision_action}, action:"\
+      " #{@action}, released: #{@released}, reviewed: #{@reviewed}, inactive: #{@inactive},"\
+      " frozen: #{@frozen}, release_action: #{@release_action}, delayed_funding_start_date:"\
+      " #{@delayed_funding_start_date}, delayed_funding_end_date: #{@delayed_funding_end_date},"\
+      " analyst: #{@analyst}, claimed: #{@claimed}, hold_source: #{@hold_source}, hold_source_id:"\
+      " #{@hold_source_id}, hold_source_details: #{@hold_source_details}, division: #{@division},"\
+      " message_thread: #{@message_thread}, notes: #{@notes}, reserve_entries:"\
+      " #{@reserve_entries}, reserve: #{@reserve}>"
+    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}, txn: #{@txn.inspect}, terminal_txn:"\
+      " #{@terminal_txn.inspect}, account: #{@account.inspect}, verification:"\
+      " #{@verification.inspect}, verification_ref: #{@verification_ref.inspect}, decision_action:"\
+      " #{@decision_action.inspect}, action: #{@action.inspect}, released: #{@released.inspect},"\
+      " reviewed: #{@reviewed.inspect}, inactive: #{@inactive.inspect}, frozen:"\
+      " #{@frozen.inspect}, release_action: #{@release_action.inspect},"\
+      " delayed_funding_start_date: #{@delayed_funding_start_date.inspect},"\
+      " delayed_funding_end_date: #{@delayed_funding_end_date.inspect}, analyst:"\
+      " #{@analyst.inspect}, claimed: #{@claimed.inspect}, hold_source: #{@hold_source.inspect},"\
+      " hold_source_id: #{@hold_source_id.inspect}, hold_source_details:"\
+      " #{@hold_source_details.inspect}, division: #{@division.inspect}, message_thread:"\
+      " #{@message_thread.inspect}, notes: #{@notes.inspect}, reserve_entries:"\
+      " #{@reserve_entries.inspect}, reserve: #{@reserve.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/holds_response_item.rb

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

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

@@ -0,0 +1,23 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # hostThemesDefault.
+  class HostThemesDefaultEnum
+    HOST_THEMES_DEFAULT_ENUM = [
+      # ON
+      ON = 0,
+
+      # OFF
+      OFF = 1
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      HOST_THEMES_DEFAULT_ENUM.include?(value)
+    end
+  end
+end