Class: PCPServerSDK::Models::OrderLineDetailsInput

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderLineDetailsInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 102

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

  if attributes.key?(:'product_price')
    self.product_price = attributes[:'product_price']
  else
    self.product_price = nil
  end

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

  if attributes.key?(:'quantity')
    self.quantity = attributes[:'quantity']
  else
    self.quantity = nil
  end

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

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

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

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

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

Instance Attribute Details

#merchant_shop_delivery_reference ⇒ Object

Optional parameter to define the delivery shop or touchpoint where an item has been collected (e.g. for Click & Collect or Click & Reserve).



33
34
35
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 33

def merchant_shop_delivery_reference
  @merchant_shop_delivery_reference
end

#product_category_path ⇒ Object

Category path of the item. Used for PAYONE Buy Now, Pay Later (BNPL).



30
31
32
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 30

def product_category_path
  @product_category_path
end

#product_code ⇒ Object

Product or UPC Code



10
11
12
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 10

def product_code
  @product_code
end

#product_image_url ⇒ Object

URL of a product image. Used for PAYONE Buy Now, Pay Later (BNPL).



27
28
29
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 27

def product_image_url
  @product_image_url
end

#product_price ⇒ Object

The price of one unit of the product, the value should be zero or greater.



13
14
15
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 13

def product_price
  @product_price
end

#product_type ⇒ Object

Returns the value of attribute product_type.



15
16
17
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 15

def product_type
  @product_type
end

#product_url ⇒ Object

URL of the product in shop. Used for PAYONE Buy Now, Pay Later (BNPL).



24
25
26
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 24

def product_url
  @product_url
end

#quantity ⇒ Object

Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros



18
19
20
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 18

def quantity
  @quantity
end

#tax_amount ⇒ Object

Tax on the line item, with the last two digits implied as decimal places



21
22
23
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 21

def tax_amount
  @tax_amount
end

Class Method Details

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



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
246
247
248
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 211

def self._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 = PCPServerSDK::Models.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 60

def self.attribute_map
  {
    :'product_code' => :'productCode',
    :'product_price' => :'productPrice',
    :'product_type' => :'productType',
    :'quantity' => :'quantity',
    :'tax_amount' => :'taxAmount',
    :'product_url' => :'productUrl',
    :'product_image_url' => :'productImageUrl',
    :'product_category_path' => :'productCategoryPath',
    :'merchant_shop_delivery_reference' => :'merchantShopDeliveryReference'
  }
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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 187

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



95
96
97
98
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 95

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 80

def self.openapi_types
  {
    :'product_code' => :'String',
    :'product_price' => :'Integer',
    :'product_type' => :'ProductType',
    :'quantity' => :'Integer',
    :'tax_amount' => :'Integer',
    :'product_url' => :'String',
    :'product_image_url' => :'String',
    :'product_category_path' => :'String',
    :'merchant_shop_delivery_reference' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      product_code == o.product_code &&
      product_price == o.product_price &&
      product_type == o.product_type &&
      quantity == o.quantity &&
      tax_amount == o.tax_amount &&
      product_url == o.product_url &&
      product_image_url == o.product_image_url &&
      product_category_path == o.product_category_path &&
      merchant_shop_delivery_reference == o.merchant_shop_delivery_reference
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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 282

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


174
175
176
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 180

def hash
  [product_code, product_price, product_type, quantity, tax_amount, product_url, product_image_url, product_category_path, merchant_shop_delivery_reference].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



258
259
260
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 258

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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 264

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



252
253
254
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_input.rb', line 252

def to_s
  to_hash.to_s
end