Class: TripletexRubyClient::OrderLine

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/models/order_line.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderLine

Initializes the object

Parameters:

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

    Model attributes in the form of hash



133
134
135
136
137
138
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
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
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 133

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

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

  if attributes.has_key?(:'changes')
    if (value = attributes[:'changes']).is_a?(Array)
      self.changes = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount_excluding_vat_currency ⇒ Object

Total amount on order line excluding VAT in the order’s currency



54
55
56
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 54

def amount_excluding_vat_currency
  @amount_excluding_vat_currency
end

#amount_including_vat_currency ⇒ Object

Total amount on order line including VAT in the order’s currency



57
58
59
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 57

def amount_including_vat_currency
  @amount_including_vat_currency
end

#changes ⇒ Object

Returns the value of attribute changes.



21
22
23
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 21

def changes
  @changes
end

#count ⇒ Object

Returns the value of attribute count.



34
35
36
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 34

def count
  @count
end

#currency ⇒ Object

The order line’s currency. Determined by the order’s currency.



43
44
45
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 43

def currency
  @currency
end

#description ⇒ Object

Returns the value of attribute description.



32
33
34
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 32

def description
  @description
end

#discount ⇒ Object

Discount given as a percentage (%)



49
50
51
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 49

def discount
  @discount
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 17

def id
  @id
end

#inventory ⇒ Object

Returns the value of attribute inventory.



27
28
29
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 27

def inventory
  @inventory
end

#inventory_location ⇒ Object

Inventory location field – beta program



30
31
32
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 30

def inventory_location
  @inventory_location
end

#is_subscription ⇒ Object

Returns the value of attribute is_subscription.



65
66
67
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 65

def is_subscription
  @is_subscription
end

#markup ⇒ Object

Markup given as a percentage (%)



46
47
48
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 46

def markup
  @markup
end

#order ⇒ Object

The related Order for this OrderLine. This field is required when creating a new OrderLine in the API.



60
61
62
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 60

def order
  @order
end

#order_group ⇒ Object

Returns the value of attribute order_group.



71
72
73
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 71

def order_group
  @order_group
end

#product ⇒ Object

Returns the value of attribute product.



25
26
27
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 25

def product
  @product
end

#subscription_period_end ⇒ Object

Returns the value of attribute subscription_period_end.



69
70
71
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 69

def subscription_period_end
  @subscription_period_end
end

#subscription_period_start ⇒ Object

Returns the value of attribute subscription_period_start.



67
68
69
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 67

def subscription_period_start
  @subscription_period_start
end

#unit_cost_currency ⇒ Object

Unit price purchase (cost) excluding VAT in the order’s currency



37
38
39
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 37

def unit_cost_currency
  @unit_cost_currency
end

#unit_price_excluding_vat_currency ⇒ Object

Unit price of purchase excluding VAT in the order’s currency



40
41
42
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 40

def unit_price_excluding_vat_currency
  @unit_price_excluding_vat_currency
end

#unit_price_including_vat_currency ⇒ Object

Unit price of purchase including VAT in the order’s currency



63
64
65
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 63

def unit_price_including_vat_currency
  @unit_price_including_vat_currency
end

#url ⇒ Object

Returns the value of attribute url.



23
24
25
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 23

def url
  @url
end

#vat_type ⇒ Object

Returns the value of attribute vat_type.



51
52
53
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 51

def vat_type
  @vat_type
end

#version ⇒ Object

Returns the value of attribute version.



19
20
21
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 19

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'product' => :'product',
    :'inventory' => :'inventory',
    :'inventory_location' => :'inventoryLocation',
    :'description' => :'description',
    :'count' => :'count',
    :'unit_cost_currency' => :'unitCostCurrency',
    :'unit_price_excluding_vat_currency' => :'unitPriceExcludingVatCurrency',
    :'currency' => :'currency',
    :'markup' => :'markup',
    :'discount' => :'discount',
    :'vat_type' => :'vatType',
    :'amount_excluding_vat_currency' => :'amountExcludingVatCurrency',
    :'amount_including_vat_currency' => :'amountIncludingVatCurrency',
    :'order' => :'order',
    :'unit_price_including_vat_currency' => :'unitPriceIncludingVatCurrency',
    :'is_subscription' => :'isSubscription',
    :'subscription_period_start' => :'subscriptionPeriodStart',
    :'subscription_period_end' => :'subscriptionPeriodEnd',
    :'order_group' => :'orderGroup'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 103

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'product' => :'Product',
    :'inventory' => :'Inventory',
    :'inventory_location' => :'InventoryLocation',
    :'description' => :'String',
    :'count' => :'Float',
    :'unit_cost_currency' => :'Float',
    :'unit_price_excluding_vat_currency' => :'Float',
    :'currency' => :'Currency',
    :'markup' => :'Float',
    :'discount' => :'Float',
    :'vat_type' => :'VatType',
    :'amount_excluding_vat_currency' => :'Float',
    :'amount_including_vat_currency' => :'Float',
    :'order' => :'Order',
    :'unit_price_including_vat_currency' => :'Float',
    :'is_subscription' => :'BOOLEAN',
    :'subscription_period_start' => :'String',
    :'subscription_period_end' => :'String',
    :'order_group' => :'OrderGroup'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      product == o.product &&
      inventory == o.inventory &&
      inventory_location == o.inventory_location &&
      description == o.description &&
      count == o.count &&
      unit_cost_currency == o.unit_cost_currency &&
      unit_price_excluding_vat_currency == o.unit_price_excluding_vat_currency &&
      currency == o.currency &&
      markup == o.markup &&
      discount == o.discount &&
      vat_type == o.vat_type &&
      amount_excluding_vat_currency == o.amount_excluding_vat_currency &&
      amount_including_vat_currency == o.amount_including_vat_currency &&
      order == o.order &&
      unit_price_including_vat_currency == o.unit_price_including_vat_currency &&
      is_subscription == o.is_subscription &&
      subscription_period_start == o.subscription_period_start &&
      subscription_period_end == o.subscription_period_end &&
      order_group == o.order_group
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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 313

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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 379

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 292

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


279
280
281
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



285
286
287
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 285

def hash
  [id, version, changes, url, product, inventory, inventory_location, description, count, unit_cost_currency, unit_price_excluding_vat_currency, currency, markup, discount, vat_type, amount_excluding_vat_currency, amount_including_vat_currency, order, unit_price_including_vat_currency, is_subscription, subscription_period_start, subscription_period_end, order_group].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



236
237
238
239
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 236

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



359
360
361
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 359

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



365
366
367
368
369
370
371
372
373
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 365

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



353
354
355
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 353

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



243
244
245
 
# File 'lib/tripletex_ruby_client/models/order_line.rb', line 243

def valid?
  true
end