Class: CyberSource::Ptsv2paymentsAgreementInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsAgreementInformation

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



42
43
44
45
46
47
48
49
50
51
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 42

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'agreementId')
    self.agreement_id = attributes[:'agreementId']
  end
end

Instance Attribute Details

#agreement_idObject

Identifier for the mandate being signed for. This mandate id is required for all the subsequent transactions.



17
18
19
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 17

def agreement_id
  @agreement_id
end

Class Method Details

.attribute_mapObject

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



20
21
22
23
24
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 20

def self.attribute_map
  {
    :'agreement_id' => :'agreementId'
  }
end

.json_mapObject

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



27
28
29
30
31
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 27

def self.json_map
  {
    :'agreement_id' => :'agreement_id'
  }
end

.swagger_typesObject

Attribute type mapping.



34
35
36
37
38
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 34

def self.swagger_types
  {
    :'agreement_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



68
69
70
71
72
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 68

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      agreement_id == o.agreement_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 110

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
    temp_model = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



176
177
178
179
180
181
182
183
184
185
186
187
188
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 176

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 89

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


76
77
78
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 76

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



82
83
84
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 82

def hash
  [agreement_id].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



55
56
57
58
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 55

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



156
157
158
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 156

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



162
163
164
165
166
167
168
169
170
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 162

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



150
151
152
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 150

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



62
63
64
# File 'lib/cybersource_rest_client/models/ptsv2payments_agreement_information.rb', line 62

def valid?
  true
end