Class: UltracartClient::ItemContent

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemContent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/ultracart_api/models/item_content.rb', line 96

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?(:'assignments')
    if (value = attributes[:'assignments']).is_a?(Array)
      self.assignments = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assignments ⇒ Object

StoreFront assignments



18
19
20
 
# File 'lib/ultracart_api/models/item_content.rb', line 18

def assignments
  @assignments
end

#attributes ⇒ Object

StoreFront attributes



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

def attributes
  @attributes
end

#custom_thank_you_url ⇒ Object

Custom Thank You URL



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

def custom_thank_you_url
  @custom_thank_you_url
end

#exclude_from_search ⇒ Object

Exclude from search



27
28
29
 
# File 'lib/ultracart_api/models/item_content.rb', line 27

def exclude_from_search
  @exclude_from_search
end

#exclude_from_sitemap ⇒ Object

Exclude from the sitemap for the StoreFront



30
31
32
 
# File 'lib/ultracart_api/models/item_content.rb', line 30

def exclude_from_sitemap
  @exclude_from_sitemap
end

#exclude_from_top_sellers ⇒ Object

Exclude from the top sellers list in the StoreFront



33
34
35
 
# File 'lib/ultracart_api/models/item_content.rb', line 33

def exclude_from_top_sellers
  @exclude_from_top_sellers
end

#extended_description ⇒ Object

Extended description (max 10000 characters)



36
37
38
 
# File 'lib/ultracart_api/models/item_content.rb', line 36

def extended_description
  @extended_description
end

#extended_description_translated_text_instance_oid ⇒ Object

Extneded description text translation instance identifier



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

def extended_description_translated_text_instance_oid
  @extended_description_translated_text_instance_oid
end

#multimedia ⇒ Object

Multimedia



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

def multimedia
  @multimedia
end

#new_item ⇒ Object

True if the item is new



45
46
47
 
# File 'lib/ultracart_api/models/item_content.rb', line 45

def new_item
  @new_item
end

#new_item_end ⇒ Object

The date the item should no longer be considered new



48
49
50
 
# File 'lib/ultracart_api/models/item_content.rb', line 48

def new_item_end
  @new_item_end
end

#new_item_start ⇒ Object

The date the item should start being considered new



51
52
53
 
# File 'lib/ultracart_api/models/item_content.rb', line 51

def new_item_start
  @new_item_start
end

#view_url ⇒ Object

Legacy view URL (not used by StoreFronts)



54
55
56
 
# File 'lib/ultracart_api/models/item_content.rb', line 54

def view_url
  @view_url
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ultracart_api/models/item_content.rb', line 57

def self.attribute_map
  {
    :'assignments' => :'assignments',
    :'attributes' => :'attributes',
    :'custom_thank_you_url' => :'custom_thank_you_url',
    :'exclude_from_search' => :'exclude_from_search',
    :'exclude_from_sitemap' => :'exclude_from_sitemap',
    :'exclude_from_top_sellers' => :'exclude_from_top_sellers',
    :'extended_description' => :'extended_description',
    :'extended_description_translated_text_instance_oid' => :'extended_description_translated_text_instance_oid',
    :'multimedia' => :'multimedia',
    :'new_item' => :'new_item',
    :'new_item_end' => :'new_item_end',
    :'new_item_start' => :'new_item_start',
    :'view_url' => :'view_url'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'assignments' => :'Array<ItemContentAssignment>',
    :'attributes' => :'Array<ItemContentAttribute>',
    :'custom_thank_you_url' => :'String',
    :'exclude_from_search' => :'BOOLEAN',
    :'exclude_from_sitemap' => :'BOOLEAN',
    :'exclude_from_top_sellers' => :'BOOLEAN',
    :'extended_description' => :'String',
    :'extended_description_translated_text_instance_oid' => :'Integer',
    :'multimedia' => :'Array<ItemContentMultimedia>',
    :'new_item' => :'BOOLEAN',
    :'new_item_end' => :'String',
    :'new_item_start' => :'String',
    :'view_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/ultracart_api/models/item_content.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assignments == o.assignments &&
      attributes == o.attributes &&
      custom_thank_you_url == o.custom_thank_you_url &&
      exclude_from_search == o.exclude_from_search &&
      exclude_from_sitemap == o.exclude_from_sitemap &&
      exclude_from_top_sellers == o.exclude_from_top_sellers &&
      extended_description == o.extended_description &&
      extended_description_translated_text_instance_oid == o.extended_description_translated_text_instance_oid &&
      multimedia == o.multimedia &&
      new_item == o.new_item &&
      new_item_end == o.new_item_end &&
      new_item_start == o.new_item_start &&
      view_url == o.view_url
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



245
246
247
248
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
276
277
278
279
280
281
 
# File 'lib/ultracart_api/models/item_content.rb', line 245

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/ultracart_api/models/item_content.rb', line 311

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/ultracart_api/models/item_content.rb', line 224

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


211
212
213
 
# File 'lib/ultracart_api/models/item_content.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



217
218
219
 
# File 'lib/ultracart_api/models/item_content.rb', line 217

def hash
  [assignments, attributes, custom_thank_you_url, exclude_from_search, exclude_from_sitemap, exclude_from_top_sellers, extended_description, extended_description_translated_text_instance_oid, multimedia, new_item, new_item_end, new_item_start, view_url].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



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

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



291
292
293
 
# File 'lib/ultracart_api/models/item_content.rb', line 291

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



297
298
299
300
301
302
303
304
305
 
# File 'lib/ultracart_api/models/item_content.rb', line 297

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



285
286
287
 
# File 'lib/ultracart_api/models/item_content.rb', line 285

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



174
175
176
177
 
# File 'lib/ultracart_api/models/item_content.rb', line 174

def valid?
  return false if !@extended_description.nil? && @extended_description.to_s.length > 10000
  true
end