Class: Hubspot::Automation::Actions::InputFieldDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/automation/actions/models/input_field_definition.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InputFieldDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 75

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

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

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

Instance Attribute Details

#is_required ⇒ Object

Whether the field is required for the custom action to be valid



25
26
27
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 25

def is_required
  @is_required
end

#supported_value_types ⇒ Object

Controls what kind of input a customer can use to specify the field value. Must contain exactly one of ‘STATIC_VALUE` or `OBJECT_PROPERTY`. If `STATIC_VALUE`, the customer will be able to choose a value when configuring the custom action; if `OBJECT_PROPERTY`, the customer will be able to choose a property from the enrolled workflow object that the field value will be copied from. In the future we may support more than one input control type here.



22
23
24
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 22

def supported_value_types
  @supported_value_types
end

#type_definition ⇒ Object

Returns the value of attribute type_definition.



19
20
21
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 19

def type_definition
  @type_definition
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 50

def self.attribute_map
  {
    :'type_definition' => :'typeDefinition',
    :'supported_value_types' => :'supportedValueTypes',
    :'is_required' => :'isRequired'
  }
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



151
152
153
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 151

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



68
69
70
71
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 68

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

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 59

def self.openapi_types
  {
    :'type_definition' => :'FieldTypeDefinition',
    :'supported_value_types' => :'Array<String>',
    :'is_required' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type_definition == o.type_definition &&
      supported_value_types == o.supported_value_types &&
      is_required == o.is_required
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



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
208
209
210
211
212
213
214
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 179

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::Automation::Actions.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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 248

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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 158

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


138
139
140
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 138

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



144
145
146
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 144

def hash
  [type_definition, supported_value_types, is_required].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



105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 105

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

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



224
225
226
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 224

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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 230

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



218
219
220
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 218

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



120
121
122
123
124
 
# File 'lib/hubspot/codegen/automation/actions/models/input_field_definition.rb', line 120

def valid?
  return false if @type_definition.nil?
  return false if @is_required.nil?
  true
end