class Yapstone::CompositeDisputeEvent

Represents singe dispute event

Attributes

created_on[RW]
dispute_workflow[RW]

Dispute event status

evidence[RW]
type[RW]

Dispute event type

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 51
def self.attribute_map
  {
    :'type' => :'type',
    :'dispute_workflow' => :'disputeWorkflow',
    :'created_on' => :'createdOn',
    :'evidence' => :'evidence'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 175
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 72
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Yapstone::CompositeDisputeEvent` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Yapstone::CompositeDisputeEvent`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'dispute_workflow')
    self.dispute_workflow = attributes[:'dispute_workflow']
  end

  if attributes.key?(:'created_on')
    self.created_on = attributes[:'created_on']
  end

  if attributes.key?(:'evidence')
    self.evidence = attributes[:'evidence']
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 61
def self.openapi_types
  {
    :'type' => :'String',
    :'dispute_workflow' => :'String',
    :'created_on' => :'DateTime',
    :'evidence' => :'CompositeEvidenceResponse'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 151
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      dispute_workflow == o.dispute_workflow &&
      created_on == o.created_on &&
      evidence == o.evidence
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 203
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    Yapstone.const_get(type).build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 268
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 182
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
dispute_workflow=(dispute_workflow) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] dispute_workflow Object to be assigned

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 141
def dispute_workflow=(dispute_workflow)
  validator = EnumAttributeValidator.new('String', ["ARBITRATION", "CHARGEBACK", "CHARGEBACK_CANCEL", "CHARGEBACK_CREDIT", "COMPLIANCE", "FIRST_CHARGEBACK", "INQUIRY", "PRE_ARBITRATION", "PRE_COMPLIANCE", "REPRESENTMENT", "REPRESENTMENT_REJECT", "RETRIEVAL_REQUEST", "SECOND_CHARGEBACK", "UNKNOWN"])
  unless validator.valid?(dispute_workflow)
    fail ArgumentError, "invalid value for \"dispute_workflow\", must be one of #{validator.allowable_values}."
  end
  @dispute_workflow = dispute_workflow
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 162
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 168
def hash
  [type, dispute_workflow, created_on, evidence].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 104
def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @created_on.nil?
    invalid_properties.push('invalid value for "created_on", created_on cannot be nil.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 248
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 254
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 242
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 131
def type=(type)
  validator = EnumAttributeValidator.new('String', ["EVIDENCE_REQUESTED", "EVIDENCE_RECEIVED", "EVIDENCE_SUBMITTED", "DISPUTE_ACCEPTED"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
  end
  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/yapstone-disputes/models/composite_dispute_event.rb, line 119
def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["EVIDENCE_REQUESTED", "EVIDENCE_RECEIVED", "EVIDENCE_SUBMITTED", "DISPUTE_ACCEPTED"])
  return false unless type_validator.valid?(@type)
  dispute_workflow_validator = EnumAttributeValidator.new('String', ["ARBITRATION", "CHARGEBACK", "CHARGEBACK_CANCEL", "CHARGEBACK_CREDIT", "COMPLIANCE", "FIRST_CHARGEBACK", "INQUIRY", "PRE_ARBITRATION", "PRE_COMPLIANCE", "REPRESENTMENT", "REPRESENTMENT_REJECT", "RETRIEVAL_REQUEST", "SECOND_CHARGEBACK", "UNKNOWN"])
  return false unless dispute_workflow_validator.valid?(@dispute_workflow)
  return false if @created_on.nil?
  true
end