Class: NewStoreApi::TransactionItemDto

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/new_store_api/models/transaction_item_dto.rb

Overview

TransactionItemDto Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(item_price = nil, quantity = nil, shipping_address = nil, shipping_origin = nil, tax_class = nil, tax_method = nil, type = nil, consumer_uuid = SKIP, currency_consumer = SKIP, extended_attributes = SKIP, handling_charges = SKIP, id = SKIP, product_id = SKIP, product_name = SKIP, product_sku = SKIP) ⇒ TransactionItemDto

Returns a new instance of TransactionItemDto.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 114

def initialize(item_price = nil, quantity = nil, shipping_address = nil,
               shipping_origin = nil, tax_class = nil, tax_method = nil,
               type = nil, consumer_uuid = SKIP, currency_consumer = SKIP,
               extended_attributes = SKIP, handling_charges = SKIP,
               id = SKIP, product_id = SKIP, product_name = SKIP,
               product_sku = SKIP)
  @consumer_uuid = consumer_uuid unless consumer_uuid == SKIP
  @currency_consumer = currency_consumer unless currency_consumer == SKIP
  @extended_attributes = extended_attributes unless extended_attributes == SKIP
  @handling_charges = handling_charges unless handling_charges == SKIP
  @id = id unless id == SKIP
  @item_price = item_price
  @product_id = product_id unless product_id == SKIP
  @product_name = product_name unless product_name == SKIP
  @product_sku = product_sku unless product_sku == SKIP
  @quantity = quantity
  @shipping_address = shipping_address
  @shipping_origin = shipping_origin
  @tax_class = tax_class
  @tax_method = tax_method
  @type = type
end

Instance Attribute Details

#consumer_uuid ⇒ String

UUID of the consumer.

Returns:

  • (String) 


14
15
16
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 14

def consumer_uuid
  @consumer_uuid
end

#currency_consumer ⇒ String

Currency code shown and billed to the consumer.

Returns:

  • (String) 


18
19
20
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 18

def currency_consumer
  @currency_consumer
end

#extended_attributes ⇒ Array[ExtAttrResource]

The item's list of extended attributes.

Returns:



22
23
24
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 22

def extended_attributes
  @extended_attributes
end

#handling_charges ⇒ Float

Cost of handling.

Returns:

  • (Float) 


26
27
28
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 26

def handling_charges
  @handling_charges
end

#id ⇒ String

Unique identifier of the item.

Returns:

  • (String) 


30
31
32
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 30

def id
  @id
end

#item_price ⇒ Float

Price per quantity 1 of the item, can be incl. or excl. tax depending on tax_method.

Returns:

  • (Float) 


35
36
37
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 35

def item_price
  @item_price
end

#product_id ⇒ String

Unique identifier of the product.

Returns:

  • (String) 


39
40
41
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 39

def product_id
  @product_id
end

#product_name ⇒ String

Human-readable name of the product.

Returns:

  • (String) 


43
44
45
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 43

def product_name
  @product_name
end

#product_sku ⇒ String

SKU of the product.

Returns:

  • (String) 


47
48
49
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 47

def product_sku
  @product_sku
end

#quantity ⇒ Integer

Item quantity. Positive number for sold items and negative number for returned items

Returns:

  • (Integer) 


52
53
54
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 52

def quantity
  @quantity
end

#shipping_address ⇒ TransactionAddressDto

Consumer's shipping address.

Returns:



56
57
58
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 56

def shipping_address
  @shipping_address
end

#shipping_origin ⇒ TransactionAddressDto

The origin of goods address, e.g. physical address of a store.

Returns:



60
61
62
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 60

def shipping_origin
  @shipping_origin
end

#tax_class ⇒ String

Tax classification identifier for the line item.

Returns:

  • (String) 


64
65
66
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 64

def tax_class
  @tax_class
end

#tax_method ⇒ SalesOrderTaxMethodEnum

Tax classification identifier for the line item.

Returns:



68
69
70
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 68

def tax_method
  @tax_method
end

#type ⇒ ItemTypeEnum

Tax classification identifier for the line item.

Returns:



72
73
74
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 72

def type
  @type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 138

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  item_price = hash.key?('item_price') ? hash['item_price'] : nil
  quantity = hash.key?('quantity') ? hash['quantity'] : nil
  shipping_address = TransactionAddressDto.from_hash(hash['shipping_address']) if
    hash['shipping_address']
  shipping_origin = TransactionAddressDto.from_hash(hash['shipping_origin']) if
    hash['shipping_origin']
  tax_class = hash.key?('tax_class') ? hash['tax_class'] : nil
  tax_method = hash.key?('tax_method') ? hash['tax_method'] : nil
  type = hash.key?('type') ? hash['type'] : nil
  consumer_uuid = hash.key?('consumer_uuid') ? hash['consumer_uuid'] : SKIP
  currency_consumer =
    hash.key?('currency_consumer') ? hash['currency_consumer'] : SKIP
  # Parameter is an array, so we need to iterate through it
  extended_attributes = nil
  unless hash['extended_attributes'].nil?
    extended_attributes = []
    hash['extended_attributes'].each do |structure|
      extended_attributes << (ExtAttrResource.from_hash(structure) if structure)
    end
  end

  extended_attributes = SKIP unless hash.key?('extended_attributes')
  handling_charges =
    hash.key?('handling_charges') ? hash['handling_charges'] : SKIP
  id = hash.key?('id') ? hash['id'] : SKIP
  product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
  product_name = hash.key?('product_name') ? hash['product_name'] : SKIP
  product_sku = hash.key?('product_sku') ? hash['product_sku'] : SKIP

  # Create object from extracted values.
  TransactionItemDto.new(item_price,
                         quantity,
                         shipping_address,
                         shipping_origin,
                         tax_class,
                         tax_method,
                         type,
                         consumer_uuid,
                         currency_consumer,
                         extended_attributes,
                         handling_charges,
                         id,
                         product_id,
                         product_name,
                         product_sku)
end

.names ⇒ Object

A mapping from model property names to API property names.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 75

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['consumer_uuid'] = 'consumer_uuid'
  @_hash['currency_consumer'] = 'currency_consumer'
  @_hash['extended_attributes'] = 'extended_attributes'
  @_hash['handling_charges'] = 'handling_charges'
  @_hash['id'] = 'id'
  @_hash['item_price'] = 'item_price'
  @_hash['product_id'] = 'product_id'
  @_hash['product_name'] = 'product_name'
  @_hash['product_sku'] = 'product_sku'
  @_hash['quantity'] = 'quantity'
  @_hash['shipping_address'] = 'shipping_address'
  @_hash['shipping_origin'] = 'shipping_origin'
  @_hash['tax_class'] = 'tax_class'
  @_hash['tax_method'] = 'tax_method'
  @_hash['type'] = 'type'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



110
111
112
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 110

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 96

def self.optionals
  %w[
    consumer_uuid
    currency_consumer
    extended_attributes
    handling_charges
    id
    product_id
    product_name
    product_sku
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



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
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 191

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.item_price,
                            ->(val) { val.instance_of? Float }) and
        APIHelper.valid_type?(value.quantity,
                              ->(val) { val.instance_of? Integer }) and
        APIHelper.valid_type?(value.shipping_address,
                              ->(val) { TransactionAddressDto.validate(val) },
                              is_model_hash: true) and
        APIHelper.valid_type?(value.shipping_origin,
                              ->(val) { TransactionAddressDto.validate(val) },
                              is_model_hash: true) and
        APIHelper.valid_type?(value.tax_class,
                              ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.tax_method,
                              ->(val) { SalesOrderTaxMethodEnum.validate(val) }) and
        APIHelper.valid_type?(value.type,
                              ->(val) { ItemTypeEnum.validate(val) })
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['item_price'],
                          ->(val) { val.instance_of? Float }) and
      APIHelper.valid_type?(value['quantity'],
                            ->(val) { val.instance_of? Integer }) and
      APIHelper.valid_type?(value['shipping_address'],
                            ->(val) { TransactionAddressDto.validate(val) },
                            is_model_hash: true) and
      APIHelper.valid_type?(value['shipping_origin'],
                            ->(val) { TransactionAddressDto.validate(val) },
                            is_model_hash: true) and
      APIHelper.valid_type?(value['tax_class'],
                            ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['tax_method'],
                            ->(val) { SalesOrderTaxMethodEnum.validate(val) }) and
      APIHelper.valid_type?(value['type'],
                            ->(val) { ItemTypeEnum.validate(val) })
  )
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 247

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} consumer_uuid: #{@consumer_uuid.inspect}, currency_consumer:"\
  " #{@currency_consumer.inspect}, extended_attributes: #{@extended_attributes.inspect},"\
  " handling_charges: #{@handling_charges.inspect}, id: #{@id.inspect}, item_price:"\
  " #{@item_price.inspect}, product_id: #{@product_id.inspect}, product_name:"\
  " #{@product_name.inspect}, product_sku: #{@product_sku.inspect}, quantity:"\
  " #{@quantity.inspect}, shipping_address: #{@shipping_address.inspect}, shipping_origin:"\
  " #{@shipping_origin.inspect}, tax_class: #{@tax_class.inspect}, tax_method:"\
  " #{@tax_method.inspect}, type: #{@type.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



236
237
238
239
240
241
242
243
244
 
# File 'lib/new_store_api/models/transaction_item_dto.rb', line 236

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} consumer_uuid: #{@consumer_uuid}, currency_consumer: #{@currency_consumer},"\
  " extended_attributes: #{@extended_attributes}, handling_charges: #{@handling_charges}, id:"\
  " #{@id}, item_price: #{@item_price}, product_id: #{@product_id}, product_name:"\
  " #{@product_name}, product_sku: #{@product_sku}, quantity: #{@quantity}, shipping_address:"\
  " #{@shipping_address}, shipping_origin: #{@shipping_origin}, tax_class: #{@tax_class},"\
  " tax_method: #{@tax_method}, type: #{@type}>"
end