Class: ConnectWise::MenuEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/models/menu_entry.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MenuEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


86
87
88
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
 
# File 'lib/connect_wise/models/menu_entry.rb', line 86

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::MenuEntry` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `ConnectWise::MenuEntry`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.caption = attributes[:caption] if attributes.key?(:caption)

  self.link = attributes[:link] if attributes.key?(:link)

  self.new_window_flag = attributes[:new_window_flag] if attributes.key?(:new_window_flag)

  self.id = attributes[:id] if attributes.key?(:id)

  self.menu_location = attributes[:menu_location] if attributes.key?(:menu_location)

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

  self.origin = attributes[:origin] if attributes.key?(:origin)

  self.client_id = attributes[:client_id] if attributes.key?(:client_id)

  self.add_all_locations = attributes[:add_all_locations] if attributes.key?(:add_all_locations)

  self.remove_all_locations = attributes[:remove_all_locations] if attributes.key?(:remove_all_locations)

  self.small_menu_icon_id = attributes[:small_menu_icon_id] if attributes.key?(:small_menu_icon_id)

  self.large_menu_icon_id = attributes[:large_menu_icon_id] if attributes.key?(:large_menu_icon_id)

  return unless attributes.key?(:_info)
  return unless (value = attributes[:_info]).is_a?(Hash)

  self._info = value
end

Instance Attribute Details

#_info ⇒ Object

Returns the value of attribute _info.



22
23
24
 
# File 'lib/connect_wise/models/menu_entry.rb', line 22

def _info
  @_info
end

#add_all_locations ⇒ Object

Returns the value of attribute add_all_locations.



22
23
24
 
# File 'lib/connect_wise/models/menu_entry.rb', line 22

def add_all_locations
  @add_all_locations
end

#caption ⇒ Object

Max length: 50;



17
18
19
 
# File 'lib/connect_wise/models/menu_entry.rb', line 17

def caption
  @caption
end

#client_id ⇒ Object

Only required if not already set Max length: 36;



28
29
30
 
# File 'lib/connect_wise/models/menu_entry.rb', line 28

def client_id
  @client_id
end

#id ⇒ Object

Returns the value of attribute id.



22
23
24
 
# File 'lib/connect_wise/models/menu_entry.rb', line 22

def id
  @id
end

#large_menu_icon_id ⇒ Object

Returns the value of attribute large_menu_icon_id.



22
23
24
 
# File 'lib/connect_wise/models/menu_entry.rb', line 22

def large_menu_icon_id
  @large_menu_icon_id
end

#link ⇒ Object

Max length: 2000;



20
21
22
 
# File 'lib/connect_wise/models/menu_entry.rb', line 20

def link
  @link
end

#location_ids ⇒ Object

Returns the value of attribute location_ids.



22
23
24
 
# File 'lib/connect_wise/models/menu_entry.rb', line 22

def location_ids
  @location_ids
end

#menu_location ⇒ Object

Returns the value of attribute menu_location.



22
23
24
 
# File 'lib/connect_wise/models/menu_entry.rb', line 22

def menu_location
  @menu_location
end

#new_window_flag ⇒ Object

Returns the value of attribute new_window_flag.



22
23
24
 
# File 'lib/connect_wise/models/menu_entry.rb', line 22

def new_window_flag
  @new_window_flag
end

#origin ⇒ Object

Max length: 2000;



25
26
27
 
# File 'lib/connect_wise/models/menu_entry.rb', line 25

def origin
  @origin
end

#remove_all_locations ⇒ Object

Returns the value of attribute remove_all_locations.



22
23
24
 
# File 'lib/connect_wise/models/menu_entry.rb', line 22

def remove_all_locations
  @remove_all_locations
end

#small_menu_icon_id ⇒ Object

Returns the value of attribute small_menu_icon_id.



22
23
24
 
# File 'lib/connect_wise/models/menu_entry.rb', line 22

def small_menu_icon_id
  @small_menu_icon_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/connect_wise/models/menu_entry.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/connect_wise/models/menu_entry.rb', line 31

def self.attribute_map
  {
    caption: :caption,
    link: :link,
    new_window_flag: :newWindowFlag,
    id: :id,
    menu_location: :menuLocation,
    location_ids: :locationIds,
    origin: :origin,
    client_id: :clientId,
    add_all_locations: :addAllLocations,
    remove_all_locations: :removeAllLocations,
    small_menu_icon_id: :smallMenuIconId,
    large_menu_icon_id: :largeMenuIconId,
    _info: :_info
  }
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



184
185
186
 
# File 'lib/connect_wise/models/menu_entry.rb', line 184

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



74
75
76
77
78
79
80
81
82
 
# File 'lib/connect_wise/models/menu_entry.rb', line 74

def self.openapi_nullable
  Set.new(%i[
            new_window_flag
            add_all_locations
            remove_all_locations
            small_menu_icon_id
            large_menu_icon_id
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/connect_wise/models/menu_entry.rb', line 55

def self.openapi_types
  {
    caption: :String,
    link: :String,
    new_window_flag: :Boolean,
    id: :Integer,
    menu_location: :MenuLocationReference,
    location_ids: :'Array<Integer>',
    origin: :String,
    client_id: :String,
    add_all_locations: :Boolean,
    remove_all_locations: :Boolean,
    small_menu_icon_id: :Integer,
    large_menu_icon_id: :Integer,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/connect_wise/models/menu_entry.rb', line 150

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    caption == other.caption &&
    link == other.link &&
    new_window_flag == other.new_window_flag &&
    id == other.id &&
    menu_location == other.menu_location &&
    location_ids == other.location_ids &&
    origin == other.origin &&
    client_id == other.client_id &&
    add_all_locations == other.add_all_locations &&
    remove_all_locations == other.remove_all_locations &&
    small_menu_icon_id == other.small_menu_icon_id &&
    large_menu_icon_id == other.large_menu_icon_id &&
    _info == other._info
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



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
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/connect_wise/models/menu_entry.rb', line 214

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/connect_wise/models/menu_entry.rb', line 285

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



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

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)
      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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


171
172
173
 
# File 'lib/connect_wise/models/menu_entry.rb', line 171

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



177
178
179
 
# File 'lib/connect_wise/models/menu_entry.rb', line 177

def hash
  [caption, link, new_window_flag, id, menu_location, location_ids, origin, client_id, add_all_locations, remove_all_locations, small_menu_icon_id, large_menu_icon_id, _info].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



130
131
132
133
134
135
136
137
 
# File 'lib/connect_wise/models/menu_entry.rb', line 130

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "caption", caption cannot be nil.') if @caption.nil?

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

  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



261
262
263
 
# File 'lib/connect_wise/models/menu_entry.rb', line 261

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



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/connect_wise/models/menu_entry.rb', line 267

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



255
256
257
 
# File 'lib/connect_wise/models/menu_entry.rb', line 255

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



141
142
143
144
145
146
 
# File 'lib/connect_wise/models/menu_entry.rb', line 141

def valid?
  return false if @caption.nil?
  return false if @link.nil?

  true
end