Class: UltracartClient::CustomerStoreCreditLedgerEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/customer_store_credit_ledger_entry.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerStoreCreditLedgerEntry

Initializes the object



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 78

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

Identifies the state of this ledger entry whether the entry is Vesting or Expiring



19
20
21
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 19

def action
  @action
end

#amount ⇒ Object

The amount of the activity.



22
23
24
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 22

def amount
  @amount
end

#description ⇒ Object

Description of what this ledger entry is used.



25
26
27
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 25

def description
  @description
end

#entry_dts ⇒ Object

Date time of this ledger activity.



28
29
30
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 28

def entry_dts
  @entry_dts
end

#gift_certificate_ledger_oid ⇒ Object

Gift certificate ledger oid is a primary key for this object, used internally.



31
32
33
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 31

def gift_certificate_ledger_oid
  @gift_certificate_ledger_oid
end

#gift_certificate_oid ⇒ Object

Gift certificate oid.



34
35
36
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 34

def gift_certificate_oid
  @gift_certificate_oid
end

#reference_order_id ⇒ Object

The order id if this gift certificate was used as part of the payment.



37
38
39
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 37

def reference_order_id
  @reference_order_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 40

def self.attribute_map
  {
    :'action' => :'action',
    :'amount' => :'amount',
    :'description' => :'description',
    :'entry_dts' => :'entry_dts',
    :'gift_certificate_ledger_oid' => :'gift_certificate_ledger_oid',
    :'gift_certificate_oid' => :'gift_certificate_oid',
    :'reference_order_id' => :'reference_order_id'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



177
178
179
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 177

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 71

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 58

def self.openapi_types
  {
    :'action' => :'String',
    :'amount' => :'Float',
    :'description' => :'String',
    :'entry_dts' => :'String',
    :'gift_certificate_ledger_oid' => :'Integer',
    :'gift_certificate_oid' => :'Integer',
    :'reference_order_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      amount == o.amount &&
      description == o.description &&
      entry_dts == o.entry_dts &&
      gift_certificate_ledger_oid == o.gift_certificate_ledger_oid &&
      gift_certificate_oid == o.gift_certificate_oid &&
      reference_order_id == o.reference_order_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 208

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : 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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 279

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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 184

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


164
165
166
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



170
171
172
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 170

def hash
  [action, amount, description, entry_dts, gift_certificate_ledger_oid, gift_certificate_oid, reference_order_id].hash
end

#list_invalid_properties ⇒ Object

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



122
123
124
125
126
127
128
129
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 122

def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 50
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 50.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



255
256
257
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 255

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 261

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.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



249
250
251
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 249

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



133
134
135
136
 
# File 'lib/ultracart_api/models/customer_store_credit_ledger_entry.rb', line 133

def valid?
  return false if !@description.nil? && @description.to_s.length > 50
  true
end