Class: OpenapiClient::Loyalty

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/loyalty.rb

Overview

The loyalty program information associated with this payment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Loyalty

Initializes the object



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/openapi_client/models/loyalty.rb', line 47

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Loyalty` 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 `OpenapiClient::Loyalty`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

Instance Attribute Details

#balance ⇒ Object

The balance of the loyalty program account in a program specific currency (e.g. points).



25
26
27
 
# File 'lib/openapi_client/models/loyalty.rb', line 25

def balance
  @balance
end

#id ⇒ Object

A unique ID associated with the loyalty program account. Must be unique within the merchants system. Depending on loyalty programs the account might also serve as a credit/bank account. If this is the case the ID must be not be the PAN.



19
20
21
 
# File 'lib/openapi_client/models/loyalty.rb', line 19

def id
  @id
end

#program ⇒ Object

A string that identifies the program in which the customer is enrolled if the merchant supports several programs or levels.



22
23
24
 
# File 'lib/openapi_client/models/loyalty.rb', line 22

def program
  @program
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
 
# File 'lib/openapi_client/models/loyalty.rb', line 28

def self.attribute_map
  {
    :'id' => :'id',
    :'program' => :'program',
    :'balance' => :'balance'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



111
112
113
 
# File 'lib/openapi_client/models/loyalty.rb', line 111

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
 
# File 'lib/openapi_client/models/loyalty.rb', line 37

def self.openapi_types
  {
    :'id' => :'String',
    :'program' => :'String',
    :'balance' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



88
89
90
91
92
93
94
 
# File 'lib/openapi_client/models/loyalty.rb', line 88

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      program == o.program &&
      balance == o.balance
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/openapi_client/models/loyalty.rb', line 139

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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/openapi_client/models/loyalty.rb', line 213

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/openapi_client/models/loyalty.rb', line 118

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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

See Also:

  • `==` method


98
99
100
 
# File 'lib/openapi_client/models/loyalty.rb', line 98

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



104
105
106
 
# File 'lib/openapi_client/models/loyalty.rb', line 104

def hash
  [id, program, balance].hash
end

#list_invalid_properties ⇒ Object

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



75
76
77
78
 
# File 'lib/openapi_client/models/loyalty.rb', line 75

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



189
190
191
 
# File 'lib/openapi_client/models/loyalty.rb', line 189

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash



195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/openapi_client/models/loyalty.rb', line 195

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



183
184
185
 
# File 'lib/openapi_client/models/loyalty.rb', line 183

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



82
83
84
 
# File 'lib/openapi_client/models/loyalty.rb', line 82

def valid?
  true
end