Class: PCPServerSDK::OrderLineDetailsPatch

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

Overview

Object containing additional information that when supplied can have a beneficial effect on the discountrates.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderLineDetailsPatch

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 126

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

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

  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

#id ⇒ Object

Unique identifier of a cart item



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

def id
  @id
end

#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).



48
49
50
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 48

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



45
46
47
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 45

def product_category_path
  @product_category_path
end

#product_code ⇒ Object

Product or UPC Code



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

def product_code
  @product_code
end

#product_image_url ⇒ Object

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



42
43
44
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 42

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.



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

def product_price
  @product_price
end

#product_type ⇒ Object

Returns the value of attribute product_type.



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

def product_type
  @product_type
end

#product_url ⇒ Object

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



39
40
41
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 39

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



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

def quantity
  @quantity
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#tax_amount ⇒ Object

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



36
37
38
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 36

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



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 413

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



90
91
92
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 73

def self.attribute_map
  {
    :'id' => :'id',
    :'status' => :'status',
    :'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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 389

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



118
119
120
121
122
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 118

def self.openapi_all_of
  [
  :'OrderLineDetailsInput'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 112

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 95

def self.openapi_types
  {
    :'id' => :'String',
    :'status' => :'Array<CartItemOrderStatus>',
    :'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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 358

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



484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 484

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


376
377
378
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 376

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



382
383
384
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 382

def hash
  [id, status, product_code, product_price, product_type, quantity, tax_amount, product_url, product_image_url, product_category_path, merchant_shop_delivery_reference].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



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
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 192

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @product_price.nil?
    invalid_properties.push('invalid value for "product_price", product_price cannot be nil.')
  end

  if @product_price > 2147483647
    invalid_properties.push('invalid value for "product_price", must be smaller than or equal to 2147483647.')
  end

  if @product_price < 0
    invalid_properties.push('invalid value for "product_price", must be greater than or equal to 0.')
  end

  if @quantity.nil?
    invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
  end

  if @quantity > 9999
    invalid_properties.push('invalid value for "quantity", must be smaller than or equal to 9999.')
  end

  if @quantity < 0
    invalid_properties.push('invalid value for "quantity", must be greater than or equal to 0.')
  end

  if !@tax_amount.nil? && @tax_amount > 2147483647
    invalid_properties.push('invalid value for "tax_amount", must be smaller than or equal to 2147483647.')
  end

  if !@tax_amount.nil? && @tax_amount < 0
    invalid_properties.push('invalid value for "tax_amount", must be greater than or equal to 0.')
  end

  if !@product_url.nil? && @product_url.to_s.length > 2048
    invalid_properties.push('invalid value for "product_url", the character length must be smaller than or equal to 2048.')
  end

  if !@product_image_url.nil? && @product_image_url.to_s.length > 2048
    invalid_properties.push('invalid value for "product_image_url", the character length must be smaller than or equal to 2048.')
  end

  if !@product_category_path.nil? && @product_category_path.to_s.length > 2048
    invalid_properties.push('invalid value for "product_category_path", the character length must be smaller than or equal to 2048.')
  end

  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



460
461
462
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 460

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



466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 466

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



454
455
456
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 454

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/PCP-server-Ruby-SDK/models/order_line_details_patch.rb', line 244

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @product_price.nil?
  return false if @product_price > 2147483647
  return false if @product_price < 0
  return false if @quantity.nil?
  return false if @quantity > 9999
  return false if @quantity < 0
  return false if !@tax_amount.nil? && @tax_amount > 2147483647
  return false if !@tax_amount.nil? && @tax_amount < 0
  return false if !@product_url.nil? && @product_url.to_s.length > 2048
  return false if !@product_image_url.nil? && @product_image_url.to_s.length > 2048
  return false if !@product_category_path.nil? && @product_category_path.to_s.length > 2048
  true
end