Class: Hubspot::Automation::Actions::ExtensionActionDefinitionPatch

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

Overview

Fields on custom workflow action to be updated.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtensionActionDefinitionPatch

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
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
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 80

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

  if attributes.key?(:'published')
    self.published = attributes[:'published']
  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.



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

def action_url
  @action_url
end

#input_field_dependencies ⇒ Object

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



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

def input_field_dependencies
  @input_field_dependencies
end

#input_fields ⇒ Object

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



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

def input_fields
  @input_fields
end

#labels ⇒ Object

The user-facing labels for the custom action.



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

def labels
  @labels
end

#object_request_options ⇒ Object

Returns the value of attribute object_request_options.



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

def object_request_options
  @object_request_options
end

#object_types ⇒ Object

The object types that this custom action supports.



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

def object_types
  @object_types
end

#published ⇒ Object

Whether this custom action is published to customers.



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

def published
  @published
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



55
56
57
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 55

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 42

def self.attribute_map
  {
    :'action_url' => :'actionUrl',
    :'published' => :'published',
    :'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



172
173
174
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 172

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



73
74
75
76
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 73

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 60

def self.openapi_types
  {
    :'action_url' => :'String',
    :'published' => :'Boolean',
    :'input_fields' => :'Array<InputFieldDefinition>',
    :'object_request_options' => :'ObjectRequestOptions',
    :'input_field_dependencies' => :'Array<ExtensionActionDefinitionPatchInputFieldDependenciesInner>',
    :'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



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 145

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 203

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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 274

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



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

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


159
160
161
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 159

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



165
166
167
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 165

def hash
  [action_url, published, 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



132
133
134
135
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 132

def list_invalid_properties
  invalid_properties = Array.new
  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



250
251
252
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 250

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



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

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



244
245
246
 
# File 'lib/hubspot/codegen/automation/actions/models/extension_action_definition_patch.rb', line 244

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



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

def valid?
  true
end