Class: UltracartClient::OrderGift

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderGift

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
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
140
141
 
# File 'lib/ultracart_api/models/order_gift.rb', line 89

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#gift ⇒ Object

True if the order is a gift



19
20
21
 
# File 'lib/ultracart_api/models/order_gift.rb', line 19

def gift
  @gift
end

#gift_charge ⇒ Object

Returns the value of attribute gift_charge.



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

def gift_charge
  @gift_charge
end

#gift_charge_accounting_code ⇒ Object

QuickBooks code for the gift charge



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

def gift_charge_accounting_code
  @gift_charge_accounting_code
end

#gift_charge_refunded ⇒ Object

Returns the value of attribute gift_charge_refunded.



26
27
28
 
# File 'lib/ultracart_api/models/order_gift.rb', line 26

def gift_charge_refunded
  @gift_charge_refunded
end

#gift_email ⇒ Object

Email address of the gift recipient



29
30
31
 
# File 'lib/ultracart_api/models/order_gift.rb', line 29

def gift_email
  @gift_email
end

#gift_message ⇒ Object

Message to the gift recipient



32
33
34
 
# File 'lib/ultracart_api/models/order_gift.rb', line 32

def gift_message
  @gift_message
end

#gift_wrap_accounting_code ⇒ Object

QuickBooks code for the gift wrap charge



35
36
37
 
# File 'lib/ultracart_api/models/order_gift.rb', line 35

def gift_wrap_accounting_code
  @gift_wrap_accounting_code
end

#gift_wrap_cost ⇒ Object

Returns the value of attribute gift_wrap_cost.



37
38
39
 
# File 'lib/ultracart_api/models/order_gift.rb', line 37

def gift_wrap_cost
  @gift_wrap_cost
end

#gift_wrap_refunded ⇒ Object

Returns the value of attribute gift_wrap_refunded.



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

def gift_wrap_refunded
  @gift_wrap_refunded
end

#gift_wrap_title ⇒ Object

Title of the gift wrap that the customer wants used



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

def gift_wrap_title
  @gift_wrap_title
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/ultracart_api/models/order_gift.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/ultracart_api/models/order_gift.rb', line 45

def self.attribute_map
  {
    :'gift' => :'gift',
    :'gift_charge' => :'gift_charge',
    :'gift_charge_accounting_code' => :'gift_charge_accounting_code',
    :'gift_charge_refunded' => :'gift_charge_refunded',
    :'gift_email' => :'gift_email',
    :'gift_message' => :'gift_message',
    :'gift_wrap_accounting_code' => :'gift_wrap_accounting_code',
    :'gift_wrap_cost' => :'gift_wrap_cost',
    :'gift_wrap_refunded' => :'gift_wrap_refunded',
    :'gift_wrap_title' => :'gift_wrap_title'
  }
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



233
234
235
 
# File 'lib/ultracart_api/models/order_gift.rb', line 233

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/ultracart_api/models/order_gift.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'gift' => :'Boolean',
    :'gift_charge' => :'Currency',
    :'gift_charge_accounting_code' => :'String',
    :'gift_charge_refunded' => :'Currency',
    :'gift_email' => :'String',
    :'gift_message' => :'String',
    :'gift_wrap_accounting_code' => :'String',
    :'gift_wrap_cost' => :'Currency',
    :'gift_wrap_refunded' => :'Currency',
    :'gift_wrap_title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/ultracart_api/models/order_gift.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      gift == o.gift &&
      gift_charge == o.gift_charge &&
      gift_charge_accounting_code == o.gift_charge_accounting_code &&
      gift_charge_refunded == o.gift_charge_refunded &&
      gift_email == o.gift_email &&
      gift_message == o.gift_message &&
      gift_wrap_accounting_code == o.gift_wrap_accounting_code &&
      gift_wrap_cost == o.gift_wrap_cost &&
      gift_wrap_refunded == o.gift_wrap_refunded &&
      gift_wrap_title == o.gift_wrap_title
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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ultracart_api/models/order_gift.rb', line 264

def _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 = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/ultracart_api/models/order_gift.rb', line 335

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/ultracart_api/models/order_gift.rb', line 240

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


220
221
222
 
# File 'lib/ultracart_api/models/order_gift.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/ultracart_api/models/order_gift.rb', line 226

def hash
  [gift, gift_charge, gift_charge_accounting_code, gift_charge_refunded, gift_email, gift_message, gift_wrap_accounting_code, gift_wrap_cost, gift_wrap_refunded, gift_wrap_title].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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/ultracart_api/models/order_gift.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  if !@gift_email.nil? && @gift_email.to_s.length > 100
    invalid_properties.push('invalid value for "gift_email", the character length must be smaller than or equal to 100.')
  end

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

  if !@gift_wrap_title.nil? && @gift_wrap_title.to_s.length > 30
    invalid_properties.push('invalid value for "gift_wrap_title", the character length must be smaller than or equal to 30.')
  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



311
312
313
 
# File 'lib/ultracart_api/models/order_gift.rb', line 311

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/ultracart_api/models/order_gift.rb', line 317

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



305
306
307
 
# File 'lib/ultracart_api/models/order_gift.rb', line 305

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



164
165
166
167
168
169
 
# File 'lib/ultracart_api/models/order_gift.rb', line 164

def valid?
  return false if !@gift_email.nil? && @gift_email.to_s.length > 100
  return false if !@gift_message.nil? && @gift_message.to_s.length > 10000
  return false if !@gift_wrap_title.nil? && @gift_wrap_title.to_s.length > 30
  true
end