Class: UltracartClient::OrderAffiliateLedger

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderAffiliateLedger

Initializes the object

Parameters:

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

    Model attributes in the form of hash



98
99
100
101
102
103
104
105
106
107
108
109
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
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 98

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?(:'assigned_by_user')
    self.assigned_by_user = attributes[:'assigned_by_user']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#assigned_by_user ⇒ Object

UltraCart user name that assigned this commission if manually assigned



18
19
20
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 18

def assigned_by_user
  @assigned_by_user
end

#item_id ⇒ Object

Item ID that this ledger record is associated with



21
22
23
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 21

def item_id
  @item_id
end

#tier_number ⇒ Object

Tier number of this affiliate in the commission calculation



24
25
26
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 24

def tier_number
  @tier_number
end

#transaction_amount ⇒ Object

Amount of the transaction



27
28
29
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 27

def transaction_amount
  @transaction_amount
end

#transaction_amount_paid ⇒ Object

The amount that has been paid so far on the transaction



30
31
32
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 30

def transaction_amount_paid
  @transaction_amount_paid
end

#transaction_dts ⇒ Object

The date/time that the affiliate ledger was generated for the transaction



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

def transaction_dts
  @transaction_dts
end

#transaction_memo ⇒ Object

Details of the transaction suitable for display to the affiliate



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

def transaction_memo
  @transaction_memo
end

#transaction_percentage ⇒ Object

The percentage earned on the transaction



39
40
41
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 39

def transaction_percentage
  @transaction_percentage
end

#transaction_state ⇒ Object

The state of the transaction



42
43
44
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 42

def transaction_state
  @transaction_state
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 67

def self.attribute_map
  {
    :'assigned_by_user' => :'assigned_by_user',
    :'item_id' => :'item_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

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 82

def self.swagger_types
  {
    :'assigned_by_user' => :'String',
    :'item_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



168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assigned_by_user == o.assigned_by_user &&
      item_id == o.item_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



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
246
247
248
249
250
251
252
253
254
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 218

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 = UltracartClient.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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 284

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 197

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 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


184
185
186
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 190

def hash
  [assigned_by_user, item_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



143
144
145
146
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 143

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



264
265
266
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 264

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



270
271
272
273
274
275
276
277
278
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 270

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



258
259
260
 
# File 'lib/ultracart_api/models/order_affiliate_ledger.rb', line 258

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



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

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