Class: UltracartClient::AffiliateLedger

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AffiliateLedger

Initializes the object

Parameters:

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

    Model attributes in the form of hash



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
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/affiliate_ledger.rb', line 157

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#affiliate_click_oid ⇒ Object

Unique object identifier for the click associated with this ledger entry



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

def affiliate_click_oid
  @affiliate_click_oid
end

#affiliate_ledger_oid ⇒ Object

Affiliate ledger object ID associated with this ledger



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

def affiliate_ledger_oid
  @affiliate_ledger_oid
end

#affiliate_link_oid ⇒ Object

Unique object identifier for the link that this click is associated with



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

def affiliate_link_oid
  @affiliate_link_oid
end

#affiliate_oid ⇒ Object

Affiliate object ID associated with this transaction



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

def affiliate_oid
  @affiliate_oid
end

#assigned_by_user ⇒ Object

User that assigned the transaction if it was done manually



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

def assigned_by_user
  @assigned_by_user
end

#click ⇒ Object

Returns the value of attribute click.



33
34
35
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 33

def click
  @click
end

#item_id ⇒ Object

Item ID associated with this transaction



36
37
38
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 36

def item_id
  @item_id
end

#link ⇒ Object

Returns the value of attribute link.



38
39
40
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 38

def link
  @link
end

#order ⇒ Object

Returns the value of attribute order.



40
41
42
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 40

def order
  @order
end

#order_id ⇒ Object

Order ID associated with this transaction



43
44
45
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 43

def order_id
  @order_id
end

#original_transaction_dts ⇒ Object

Date/time of the original transaction for reversals



46
47
48
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 46

def original_transaction_dts
  @original_transaction_dts
end

#sub_id ⇒ Object

Sub ID associated with transaction (from the click)



49
50
51
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 49

def sub_id
  @sub_id
end

#tier_number ⇒ Object

Tier number that this transaction earned



52
53
54
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 52

def tier_number
  @tier_number
end

#transaction_amount ⇒ Object

Transaction amount



55
56
57
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 55

def transaction_amount
  @transaction_amount
end

#transaction_amount_paid ⇒ Object

Amount of the transaction that has been paid out.



58
59
60
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 58

def transaction_amount_paid
  @transaction_amount_paid
end

#transaction_dts ⇒ Object

Date/time that the transaction was made



61
62
63
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 61

def transaction_dts
  @transaction_dts
end

#transaction_memo ⇒ Object

Memo explaining the transaction



64
65
66
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 64

def transaction_memo
  @transaction_memo
end

#transaction_percentage ⇒ Object

Percentage associated with this transaction



67
68
69
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 67

def transaction_percentage
  @transaction_percentage
end

#transaction_state ⇒ Object

Transaction state



70
71
72
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 70

def transaction_state
  @transaction_state
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



120
121
122
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 120

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 95

def self.attribute_map
  {
    :'affiliate_click_oid' => :'affiliate_click_oid',
    :'affiliate_ledger_oid' => :'affiliate_ledger_oid',
    :'affiliate_link_oid' => :'affiliate_link_oid',
    :'affiliate_oid' => :'affiliate_oid',
    :'assigned_by_user' => :'assigned_by_user',
    :'click' => :'click',
    :'item_id' => :'item_id',
    :'link' => :'link',
    :'order' => :'order',
    :'order_id' => :'order_id',
    :'original_transaction_dts' => :'original_transaction_dts',
    :'sub_id' => :'sub_id',
    :'tier_number' => :'tier_number',
    :'transaction_amount' => :'transaction_amount',
    :'transaction_amount_paid' => :'transaction_amount_paid',
    :'transaction_dts' => :'transaction_dts',
    :'transaction_memo' => :'transaction_memo',
    :'transaction_percentage' => :'transaction_percentage',
    :'transaction_state' => :'transaction_state'
  }
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



313
314
315
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 313

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



150
151
152
153
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 150

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

.openapi_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 125

def self.openapi_types
  {
    :'affiliate_click_oid' => :'Integer',
    :'affiliate_ledger_oid' => :'Integer',
    :'affiliate_link_oid' => :'Integer',
    :'affiliate_oid' => :'Integer',
    :'assigned_by_user' => :'String',
    :'click' => :'AffiliateClick',
    :'item_id' => :'String',
    :'link' => :'AffiliateLink',
    :'order' => :'Order',
    :'order_id' => :'String',
    :'original_transaction_dts' => :'String',
    :'sub_id' => :'String',
    :'tier_number' => :'Integer',
    :'transaction_amount' => :'Float',
    :'transaction_amount_paid' => :'Float',
    :'transaction_dts' => :'String',
    :'transaction_memo' => :'String',
    :'transaction_percentage' => :'Float',
    :'transaction_state' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 274

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      affiliate_click_oid == o.affiliate_click_oid &&
      affiliate_ledger_oid == o.affiliate_ledger_oid &&
      affiliate_link_oid == o.affiliate_link_oid &&
      affiliate_oid == o.affiliate_oid &&
      assigned_by_user == o.assigned_by_user &&
      click == o.click &&
      item_id == o.item_id &&
      link == o.link &&
      order == o.order &&
      order_id == o.order_id &&
      original_transaction_dts == o.original_transaction_dts &&
      sub_id == o.sub_id &&
      tier_number == o.tier_number &&
      transaction_amount == o.transaction_amount &&
      transaction_amount_paid == o.transaction_amount_paid &&
      transaction_dts == o.transaction_dts &&
      transaction_memo == o.transaction_memo &&
      transaction_percentage == o.transaction_percentage &&
      transaction_state == o.transaction_state
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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 344

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 415

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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 320

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


300
301
302
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 300

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



306
307
308
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 306

def hash
  [affiliate_click_oid, affiliate_ledger_oid, affiliate_link_oid, affiliate_oid, assigned_by_user, click, item_id, link, order, order_id, original_transaction_dts, sub_id, tier_number, transaction_amount, transaction_amount_paid, transaction_dts, transaction_memo, transaction_percentage, transaction_state].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



391
392
393
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 391

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 397

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

Returns:

  • (String) —

    String presentation of the object



385
386
387
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 385

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



256
257
258
259
260
 
# File 'lib/ultracart_api/models/affiliate_ledger.rb', line 256

def valid?
  transaction_state_validator = EnumAttributeValidator.new('String', ["Pending", "Posted", "Approved", "Paid", "Rejected", "Partially Paid"])
  return false unless transaction_state_validator.valid?(@transaction_state)
  true
end