Class: Hubspot::Automation::Actions::ExtensionActionDefinition

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtensionActionDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
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
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 92

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

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

  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?(:'archived_at')
    self.archived_at = attributes[:'archived_at']
  end

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

  if attributes.key?(:'object_request_options')
    self.object_request_options = attributes[:'object_request_options']
  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?(:'labels')
    if (value = attributes[:'labels']).is_a?(Hash)
      self.labels = value
    end
  end

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

Instance Attribute Details

#action_url ⇒ Object

The URL that will accept an HTTPS request each time workflows executes the custom action.



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

def action_url
  @action_url
end

#archived_at ⇒ Object

The date that this custom action was archived, if the custom action is archived.



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

def archived_at
  @archived_at
end

#functions ⇒ Object

A list of functions associated with the custom workflow action.



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

def functions
  @functions
end

#id ⇒ Object

The ID of the custom action.



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

def id
  @id
end

#input_field_dependencies ⇒ Object

A list of dependencies between the input fields. These configure when the input fields should be visible.



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

def input_field_dependencies
  @input_field_dependencies
end

#input_fields ⇒ Object

The list of input fields to display in this custom action.



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

def input_fields
  @input_fields
end

#labels ⇒ Object

The user-facing labels for the custom action.



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

def labels
  @labels
end

#object_request_options ⇒ Object

Returns the value of attribute object_request_options.



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

def object_request_options
  @object_request_options
end

#object_types ⇒ Object

The object types that this custom action supports.



48
49
50
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 48

def object_types
  @object_types
end

#published ⇒ Object

Whether this custom action is published to customers.



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

def published
  @published
end

#revision_id ⇒ Object

Returns the value of attribute revision_id.



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

def revision_id
  @revision_id
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 51

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



246
247
248
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 246

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



85
86
87
88
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 85

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 68

def self.openapi_types
  {
    :'id' => :'String',
    :'revision_id' => :'String',
    :'functions' => :'Array<ActionFunctionIdentifier>',
    :'action_url' => :'String',
    :'published' => :'Boolean',
    :'archived_at' => :'Integer',
    :'input_fields' => :'Array<InputFieldDefinition>',
    :'object_request_options' => :'ObjectRequestOptions',
    :'input_field_dependencies' => :'Array<OneOfSingleFieldDependencyConditionalSingleFieldDependency>',
    :'labels' => :'Hash<String, ActionLabels>',
    :'object_types' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 274

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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 343

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 253

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


233
234
235
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



239
240
241
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 239

def hash
  [id, revision_id, functions, action_url, published, archived_at, input_fields, object_request_options, input_field_dependencies, labels, object_types].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



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
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 162

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

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

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

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



319
320
321
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 319

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 325

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



313
314
315
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 313

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



201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition.rb', line 201

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