Class: Hubspot::Crm::Schemas::OptionInput

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/schemas/models/option_input.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OptionInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 64

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

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

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

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

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

Instance Attribute Details

#descriptionObject

A description of the option.


26
27
28
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 26

def description
  @description
end

#display_orderObject

Options are shown in order starting with the lowest positive integer value. Values of -1 will cause the option to be displayed after any positive values.


29
30
31
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 29

def display_order
  @display_order
end

#hiddenObject

Hidden options won't be shown in HubSpot.


32
33
34
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 32

def hidden
  @hidden
end

#labelObject

A human-readable option label that will be shown in HubSpot.


20
21
22
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 20

def label
  @label
end

#valueObject

The internal value of the option, which must be used when setting the property value through the API.


23
24
25
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 23

def value
  @value
end

Class Method Details

.attribute_mapObject

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


35
36
37
38
39
40
41
42
43
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 35

def self.attribute_map
  {
    :'label' => :'label',
    :'value' => :'value',
    :'description' => :'description',
    :'display_order' => :'displayOrder',
    :'hidden' => :'hidden'
  }
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


158
159
160
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 158

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

.openapi_nullableObject

List of attributes with nullable: true


57
58
59
60
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 57

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

.openapi_typesObject

Attribute type mapping.


46
47
48
49
50
51
52
53
54
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 46

def self.openapi_types
  {
    :'label' => :'String',
    :'value' => :'String',
    :'description' => :'String',
    :'display_order' => :'Integer',
    :'hidden' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


133
134
135
136
137
138
139
140
141
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 133

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      label == o.label &&
      value == o.value &&
      description == o.description &&
      display_order == o.display_order &&
      hidden == o.hidden
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


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 186

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
    Hubspot::Crm::Schemas.const_get(type).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


255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 255

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


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 165

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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

145
146
147
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 145

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


151
152
153
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 151

def hash
  [label, value, description, display_order, hidden].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 100

def list_invalid_properties
  invalid_properties = Array.new
  if @label.nil?
    invalid_properties.push('invalid value for "label", label cannot be nil.')
  end

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


231
232
233
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 231

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 237

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


225
226
227
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 225

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


123
124
125
126
127
128
129
# File 'lib/hubspot/codegen/crm/schemas/models/option_input.rb', line 123

def valid?
  return false if @label.nil?
  return false if @value.nil?
  return false if @display_order.nil?
  return false if @hidden.nil?
  true
end