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



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
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/ultracart_api/models/item_content.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assignments ⇒ Object

StoreFront assignments



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

def assignments
  @assignments
end

#attributes ⇒ Object

StoreFront attributes



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

def attributes
  @attributes
end

#custom_thank_you_url ⇒ Object

Custom Thank You URL



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

def custom_thank_you_url
  @custom_thank_you_url
end

#exclude_from_search ⇒ Object

Exclude from search



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

def exclude_from_search
  @exclude_from_search
end

#exclude_from_sitemap ⇒ Object

Exclude from the sitemap for the StoreFront



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

def exclude_from_sitemap
  @exclude_from_sitemap
end

#exclude_from_top_sellers ⇒ Object

Exclude from the top sellers list in the StoreFront



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

def exclude_from_top_sellers
  @exclude_from_top_sellers
end

#extended_description ⇒ Object

Extended description (max 10000 characters)



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

def extended_description
  @extended_description
end

#extended_description_translated_text_instance_oid ⇒ Object

Extended description text translation instance identifier



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

def extended_description_translated_text_instance_oid
  @extended_description_translated_text_instance_oid
end

#meta_description ⇒ Object

SEO meta description used by Storefronts



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

def meta_description
  @meta_description
end

#meta_keywords ⇒ Object

SEO meta keywords used by Storefronts



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

def meta_keywords
  @meta_keywords
end

#meta_title ⇒ Object

SEO meta title used by Storefronts



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

def meta_title
  @meta_title
end

#multimedia ⇒ Object

Multimedia



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

def multimedia
  @multimedia
end

#new_item ⇒ Object

True if the item is new



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

def new_item
  @new_item
end

#new_item_end ⇒ Object

The date the item should no longer be considered new



58
59
60
 
# File 'lib/ultracart_api/models/item_content.rb', line 58

def new_item_end
  @new_item_end
end

#new_item_start ⇒ Object

The date the item should start being considered new



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

def new_item_start
  @new_item_start
end

#view_url ⇒ Object

Legacy view URL (not used by StoreFronts)



64
65
66
 
# File 'lib/ultracart_api/models/item_content.rb', line 64

def view_url
  @view_url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/ultracart_api/models/item_content.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/ultracart_api/models/item_content.rb', line 67

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',
    :'meta_description' => :'meta_description',
    :'meta_keywords' => :'meta_keywords',
    :'meta_title' => :'meta_title',
    :'multimedia' => :'multimedia',
    :'new_item' => :'new_item',
    :'new_item_end' => :'new_item_end',
    :'new_item_start' => :'new_item_start',
    :'view_url' => :'view_url'
  }
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



273
274
275
 
# File 'lib/ultracart_api/models/item_content.rb', line 273

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/ultracart_api/models/item_content.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/ultracart_api/models/item_content.rb', line 94

def self.openapi_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',
    :'meta_description' => :'String',
    :'meta_keywords' => :'String',
    :'meta_title' => :'String',
    :'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



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

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 &&
      meta_description == o.meta_description &&
      meta_keywords == o.meta_keywords &&
      meta_title == o.meta_title &&
      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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/ultracart_api/models/item_content.rb', line 304

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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/ultracart_api/models/item_content.rb', line 375

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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/ultracart_api/models/item_content.rb', line 280

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


260
261
262
 
# File 'lib/ultracart_api/models/item_content.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



266
267
268
 
# File 'lib/ultracart_api/models/item_content.rb', line 266

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, meta_description, meta_keywords, meta_title, 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



209
210
211
212
213
214
215
216
 
# File 'lib/ultracart_api/models/item_content.rb', line 209

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



351
352
353
 
# File 'lib/ultracart_api/models/item_content.rb', line 351

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/ultracart_api/models/item_content.rb', line 357

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



345
346
347
 
# File 'lib/ultracart_api/models/item_content.rb', line 345

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



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

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