Class: Hubspot::Automation::Actions::ActionFunctionIdentifier

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ActionFunctionIdentifier

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 71

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

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

Instance Attribute Details

#function_type ⇒ Object

The type of function. This determines when the function will be called.



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

def function_type
  @function_type
end

#id ⇒ Object

The ID qualifier for the function. This is used to specify which input field a function is associated with for ‘PRE_FETCH_OPTIONS` and `POST_FETCH_OPTIONS` function types.



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

def id
  @id
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 48

def self.attribute_map
  {
    :'function_type' => :'functionType',
    :'id' => :'id'
  }
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



147
148
149
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 147

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
67
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 56

def self.openapi_types
  {
    :'function_type' => :'String',
    :'id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



125
126
127
128
129
130
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 125

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



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
208
209
210
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 175

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



244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 244

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 154

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


134
135
136
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 134

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



140
141
142
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 140

def hash
  [function_type, id].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



95
96
97
98
99
100
101
102
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 95

def list_invalid_properties
  invalid_properties = Array.new
  if @function_type.nil?
    invalid_properties.push('invalid value for "function_type", function_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



220
221
222
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 220

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



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 226

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



214
215
216
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 214

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



106
107
108
109
110
111
 
# File 'lib/hubspot/codegen/automation/actions/models/action_function_identifier.rb', line 106

def valid?
  return false if @function_type.nil?
  function_type_validator = EnumAttributeValidator.new('String', ["PRE_ACTION_EXECUTION", "PRE_FETCH_OPTIONS", "POST_FETCH_OPTIONS"])
  return false unless function_type_validator.valid?(@function_type)
  true
end