Class: Hubspot::Crm::Properties::PropertyCreate

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PropertyCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
206
207
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 137

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#calculation_formula ⇒ Object

Represents a formula that is used to compute a calculated property.



51
52
53
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 51

def calculation_formula
  @calculation_formula
end

#description ⇒ Object

A description of the property that will be shown as help text in HubSpot.



27
28
29
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 27

def description
  @description
end

#display_order ⇒ Object

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



24
25
26
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 24

def display_order
  @display_order
end

#external_options ⇒ Object

Applicable only for ‘enumeration’ type properties. Should be set to true in conjunction with a ‘referencedObjectType’ of ‘OWNER’. Otherwise false.



60
61
62
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 60

def external_options
  @external_options
end

#field_type ⇒ Object

Controls how the property appears in HubSpot.



57
58
59
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 57

def field_type
  @field_type
end

#form_field ⇒ Object

Whether or not the property can be used in a HubSpot form.



36
37
38
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 36

def form_field
  @form_field
end

#group_name ⇒ Object

The name of the property group the property belongs to.



39
40
41
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 39

def group_name
  @group_name
end

#has_unique_value ⇒ Object

Whether or not the property’s value must be unique. Once set, this can’t be changed.



54
55
56
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 54

def has_unique_value
  @has_unique_value
end

#hidden ⇒ Object

If true, the property won’t be visible and can’t be used in HubSpot.



21
22
23
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 21

def hidden
  @hidden
end

#label ⇒ Object

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



30
31
32
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 30

def label
  @label
end

#name ⇒ Object

The internal property name, which must be used when referencing the property via the API.



45
46
47
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 45

def name
  @name
end

#options ⇒ Object

A list of valid options for the property. This field is required for enumerated properties.



48
49
50
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 48

def options
  @options
end

#referenced_object_type ⇒ Object

Should be set to ‘OWNER’ when ‘externalOptions’ is true, which causes the property to dynamically pull option values from the current HubSpot users.



42
43
44
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 42

def referenced_object_type
  @referenced_object_type
end

#type ⇒ Object

The data type of the property.



33
34
35
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 33

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



105
106
107
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 105

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 85

def self.attribute_map
  {
    :'hidden' => :'hidden',
    :'display_order' => :'displayOrder',
    :'description' => :'description',
    :'label' => :'label',
    :'type' => :'type',
    :'form_field' => :'formField',
    :'group_name' => :'groupName',
    :'referenced_object_type' => :'referencedObjectType',
    :'name' => :'name',
    :'options' => :'options',
    :'calculation_formula' => :'calculationFormula',
    :'has_unique_value' => :'hasUniqueValue',
    :'field_type' => :'fieldType',
    :'external_options' => :'externalOptions'
  }
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



307
308
309
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 307

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 130

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

.openapi_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 110

def self.openapi_types
  {
    :'hidden' => :'Boolean',
    :'display_order' => :'Integer',
    :'description' => :'String',
    :'label' => :'String',
    :'type' => :'String',
    :'form_field' => :'Boolean',
    :'group_name' => :'String',
    :'referenced_object_type' => :'String',
    :'name' => :'String',
    :'options' => :'Array<OptionInput>',
    :'calculation_formula' => :'String',
    :'has_unique_value' => :'Boolean',
    :'field_type' => :'String',
    :'external_options' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 273

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      hidden == o.hidden &&
      display_order == o.display_order &&
      description == o.description &&
      label == o.label &&
      type == o.type &&
      form_field == o.form_field &&
      group_name == o.group_name &&
      referenced_object_type == o.referenced_object_type &&
      name == o.name &&
      options == o.options &&
      calculation_formula == o.calculation_formula &&
      has_unique_value == o.has_unique_value &&
      field_type == o.field_type &&
      external_options == o.external_options
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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 338

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 = Hubspot::Crm::Properties.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



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 409

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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 314

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


294
295
296
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



300
301
302
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 300

def hash
  [hidden, display_order, description, label, type, form_field, group_name, referenced_object_type, name, options, calculation_formula, has_unique_value, field_type, external_options].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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 211

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

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

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

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

  if @field_type.nil?
    invalid_properties.push('invalid value for "field_type", field_type cannot be nil.')
  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



385
386
387
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 385

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 391

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



379
380
381
 
# File 'lib/hubspot/codegen/crm/properties/models/property_create.rb', line 379

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



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

def valid?
  return false if @label.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["string", "number", "date", "datetime", "enumeration", "bool"])
  return false unless type_validator.valid?(@type)
  return false if @group_name.nil?
  return false if @name.nil?
  return false if @field_type.nil?
  field_type_validator = EnumAttributeValidator.new('String', ["textarea", "text", "date", "file", "number", "select", "radio", "checkbox", "booleancheckbox", "calculation_equation"])
  return false unless field_type_validator.valid?(@field_type)
  true
end