Class: Hubspot::Automation::Actions::PublicActionDefinition

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublicActionDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
127
128
129
130
131
132
133
134
135
136
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
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 97

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action_url ⇒ Object

Returns the value of attribute action_url.



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

def action_url
  @action_url
end

#archived_at ⇒ Object

Returns the value of attribute archived_at.



34
35
36
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 34

def archived_at
  @archived_at
end

#execution_rules ⇒ Object

Returns the value of attribute execution_rules.



38
39
40
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 38

def execution_rules
  @execution_rules
end

#functions ⇒ Object

Returns the value of attribute functions.



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

def functions
  @functions
end

#id ⇒ Object

Returns the value of attribute id.



40
41
42
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 40

def id
  @id
end

#input_field_dependencies ⇒ Object

Returns the value of attribute input_field_dependencies.



36
37
38
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 36

def input_field_dependencies
  @input_field_dependencies
end

#input_fields ⇒ Object

Returns the value of attribute input_fields.



28
29
30
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 28

def input_fields
  @input_fields
end

#labels ⇒ Object

Returns the value of attribute labels.



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

def labels
  @labels
end

#object_request_options ⇒ Object

Returns the value of attribute object_request_options.



44
45
46
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 44

def object_request_options
  @object_request_options
end

#object_types ⇒ Object

Returns the value of attribute object_types.



42
43
44
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 42

def object_types
  @object_types
end

#output_fields ⇒ Object

Returns the value of attribute output_fields.



30
31
32
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 30

def output_fields
  @output_fields
end

#published ⇒ Object

Returns the value of attribute published.



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

def published
  @published
end

#revision_id ⇒ Object

Returns the value of attribute revision_id.



32
33
34
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 32

def revision_id
  @revision_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 47

def self.attribute_map
  {
    :'functions' => :'functions',
    :'action_url' => :'actionUrl',
    :'published' => :'published',
    :'labels' => :'labels',
    :'input_fields' => :'inputFields',
    :'output_fields' => :'outputFields',
    :'revision_id' => :'revisionId',
    :'archived_at' => :'archivedAt',
    :'input_field_dependencies' => :'inputFieldDependencies',
    :'execution_rules' => :'executionRules',
    :'id' => :'id',
    :'object_types' => :'objectTypes',
    :'object_request_options' => :'objectRequestOptions'
  }
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



265
266
267
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 265

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 90

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'functions' => :'Array<PublicActionFunctionIdentifier>',
    :'action_url' => :'String',
    :'published' => :'Boolean',
    :'labels' => :'Hash<String, PublicActionLabels>',
    :'input_fields' => :'Array<InputFieldDefinition>',
    :'output_fields' => :'Array<OutputFieldDefinition>',
    :'revision_id' => :'String',
    :'archived_at' => :'Integer',
    :'input_field_dependencies' => :'Array<PublicActionDefinitionInputFieldDependenciesInner>',
    :'execution_rules' => :'Array<PublicExecutionTranslationRule>',
    :'id' => :'String',
    :'object_types' => :'Array<String>',
    :'object_request_options' => :'PublicObjectRequestOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      functions == o.functions &&
      action_url == o.action_url &&
      published == o.published &&
      labels == o.labels &&
      input_fields == o.input_fields &&
      output_fields == o.output_fields &&
      revision_id == o.revision_id &&
      archived_at == o.archived_at &&
      input_field_dependencies == o.input_field_dependencies &&
      execution_rules == o.execution_rules &&
      id == o.id &&
      object_types == o.object_types &&
      object_request_options == o.object_request_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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 296

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 367

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



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

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


252
253
254
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



258
259
260
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 258

def hash
  [functions, action_url, published, labels, input_fields, output_fields, revision_id, archived_at, input_field_dependencies, execution_rules, id, object_types, object_request_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



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/public_action_definition.rb', line 179

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

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

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

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

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

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

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

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



343
344
345
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 343

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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 349

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



337
338
339
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 337

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



218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/hubspot/codegen/automation/actions/models/public_action_definition.rb', line 218

def valid?
  return false if @functions.nil?
  return false if @action_url.nil?
  return false if @published.nil?
  return false if @labels.nil?
  return false if @input_fields.nil?
  return false if @revision_id.nil?
  return false if @id.nil?
  return false if @object_types.nil?
  true
end