Class: UltracartClient::SfvbMenuItem

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SfvbMenuItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 115

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#catalog_group_oid ⇒ Object

The catalog group page_path resolved to. Returned for reference and ignored on a write - send page_path, which is the identifier the rest of this API uses.



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

def catalog_group_oid
  @catalog_group_oid
end

#description ⇒ Object

The link text, and the only field every type needs. Required.



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

def description
  @description
end

#items ⇒ Object

This entry's sub menu, in the order it renders. Omit or send an empty array for a leaf.



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

def items
  @items
end

#merchant_item_id ⇒ Object

The item an item entry opens, by merchant item id rather than by oid.



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

def merchant_item_id
  @merchant_item_id
end

#open_in_new_window ⇒ Object

True to open the link in a new window or tab.



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

def open_in_new_window
  @open_in_new_window
end

#page_path ⇒ Object

The page a page entry opens, normalized to begin and end with a slash. This is the same path the pages endpoints take. Sent on a write and returned on a read.



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

def page_path
  @page_path
end

#social_page_type ⇒ Object

Which social network a social entry opens. The URL comes from the storefront's social settings.



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

def social_page_type
  @social_page_type
end

#system_page_type ⇒ Object

Which built in page a system page entry opens. The storefront resolves the URL, so these keep working when the checkout or account paths change.



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

def system_page_type
  @system_page_type
end

#type ⇒ Object

What the entry points at, which decides which one of the other fields is required. custom needs url, item needs merchant_item_id, page needs page_path, social needs social_page_type, and system page needs system_page_type. The legacy spelling group is accepted and stored as page.



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

def type
  @type
end

#url ⇒ Object

Where a custom entry goes. Any URL the storefront can link to, absolute or site relative.



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 71

def self.attribute_map
  {
    :'catalog_group_oid' => :'catalog_group_oid',
    :'description' => :'description',
    :'items' => :'items',
    :'merchant_item_id' => :'merchant_item_id',
    :'open_in_new_window' => :'open_in_new_window',
    :'page_path' => :'page_path',
    :'social_page_type' => :'social_page_type',
    :'system_page_type' => :'system_page_type',
    :'type' => :'type',
    :'url' => :'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



252
253
254
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 252

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 92

def self.openapi_types
  {
    :'catalog_group_oid' => :'Integer',
    :'description' => :'String',
    :'items' => :'Array<SfvbMenuItem>',
    :'merchant_item_id' => :'String',
    :'open_in_new_window' => :'Boolean',
    :'page_path' => :'String',
    :'social_page_type' => :'String',
    :'system_page_type' => :'String',
    :'type' => :'String',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      catalog_group_oid == o.catalog_group_oid &&
      description == o.description &&
      items == o.items &&
      merchant_item_id == o.merchant_item_id &&
      open_in_new_window == o.open_in_new_window &&
      page_path == o.page_path &&
      social_page_type == o.social_page_type &&
      system_page_type == o.system_page_type &&
      type == o.type &&
      url == o.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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 283

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 354

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 259

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


239
240
241
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 245

def hash
  [catalog_group_oid, description, items, merchant_item_id, open_in_new_window, page_path, social_page_type, system_page_type, type, 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



173
174
175
176
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 173

def list_invalid_properties
  invalid_properties = Array.new
  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



330
331
332
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 330

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



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

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



324
325
326
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 324

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



180
181
182
183
184
185
186
187
188
 
# File 'lib/ultracart_api/models/sfvb_menu_item.rb', line 180

def valid?
  social_page_type_validator = EnumAttributeValidator.new('String', ["Twitter", "Facebook", "Instagram", "LinkedIn", "Pinterest", "Tumblr", "YouTube"])
  return false unless social_page_type_validator.valid?(@social_page_type)
  system_page_type_validator = EnumAttributeValidator.new('String', ["Access Account", "Account Login", "Account Logout", "Affiliate Login", "Affiliate Signup", "Change Password", "My Account Main Page", "My Account Orders", "My Account Reviews", "My Account Settings", "My Account Loyalty", "Search", "Single Page Checkout", "View Cart", "Wholesale Signup"])
  return false unless system_page_type_validator.valid?(@system_page_type)
  type_validator = EnumAttributeValidator.new('String', ["custom", "item", "page", "social", "system page"])
  return false unless type_validator.valid?(@type)
  true
end