Class: Hubspot::Automation::Actions::ActionLabels
- Inherits:
-
Object
- Object
- Hubspot::Automation::Actions::ActionLabels
- Defined in:
- lib/hubspot/codegen/automation/actions/models/action_labels.rb
Instance Attribute Summary collapse
-
#action_card_content ⇒ Object
The label to be displayed in the action card of the workflow editor once this custom action has been added to a workflow.
-
#action_description ⇒ Object
A description for this custom action.
-
#action_name ⇒ Object
The name of this custom action.
-
#app_display_name ⇒ Object
The name to be displayed at the top of the action editor in the workflows app.
-
#input_field_descriptions ⇒ Object
A map of input field names to descriptions for the fields.
-
#input_field_labels ⇒ Object
A map of input field names to the user-facing labels.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ActionLabels
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ ActionLabels
Initializes the object
69 70 71 72 73 74 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 102 103 104 105 106 107 108 109 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 69 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Automation::Actions::ActionLabels` 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::ActionLabels`. 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?(:'input_field_labels') if (value = attributes[:'input_field_labels']).is_a?(Hash) self.input_field_labels = value end end if attributes.key?(:'input_field_descriptions') if (value = attributes[:'input_field_descriptions']).is_a?(Hash) self.input_field_descriptions = value end end if attributes.key?(:'action_name') self.action_name = attributes[:'action_name'] end if attributes.key?(:'action_description') self.action_description = attributes[:'action_description'] end if attributes.key?(:'app_display_name') self.app_display_name = attributes[:'app_display_name'] end if attributes.key?(:'action_card_content') self.action_card_content = attributes[:'action_card_content'] end end |
Instance Attribute Details
#action_card_content ⇒ Object
The label to be displayed in the action card of the workflow editor once this custom action has been added to a workflow.
35 36 37 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 35 def action_card_content @action_card_content end |
#action_description ⇒ Object
A description for this custom action. This will show up in the action editor along with the input fields.
29 30 31 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 29 def action_description @action_description end |
#action_name ⇒ Object
The name of this custom action. This is what will show up when users are selecting an action in the workflows app.
26 27 28 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 26 def action_name @action_name end |
#app_display_name ⇒ Object
The name to be displayed at the top of the action editor in the workflows app.
32 33 34 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 32 def app_display_name @app_display_name end |
#input_field_descriptions ⇒ Object
A map of input field names to descriptions for the fields. These will show up as tooltips when users are editing your action.
23 24 25 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 23 def input_field_descriptions @input_field_descriptions end |
#input_field_labels ⇒ Object
A map of input field names to the user-facing labels.
20 21 22 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 20 def input_field_labels @input_field_labels end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
38 39 40 41 42 43 44 45 46 47 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 38 def self.attribute_map { :'input_field_labels' => :'inputFieldLabels', :'input_field_descriptions' => :'inputFieldDescriptions', :'action_name' => :'actionName', :'action_description' => :'actionDescription', :'app_display_name' => :'appDisplayName', :'action_card_content' => :'actionCardContent' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
157 158 159 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 157 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
62 63 64 65 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 62 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
50 51 52 53 54 55 56 57 58 59 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 50 def self.openapi_types { :'input_field_labels' => :'Hash<String, String>', :'input_field_descriptions' => :'Hash<String, String>', :'action_name' => :'String', :'action_description' => :'String', :'app_display_name' => :'String', :'action_card_content' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
131 132 133 134 135 136 137 138 139 140 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 131 def ==(o) return true if self.equal?(o) self.class == o.class && input_field_labels == o.input_field_labels && input_field_descriptions == o.input_field_descriptions && action_name == o.action_name && action_description == o.action_description && app_display_name == o.app_display_name && action_card_content == o.action_card_content end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 215 216 217 218 219 220 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 185 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
254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 254 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
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 164 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
144 145 146 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 144 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
150 151 152 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 150 def hash [input_field_labels, input_field_descriptions, action_name, action_description, app_display_name, action_card_content].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
113 114 115 116 117 118 119 120 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 113 def list_invalid_properties invalid_properties = Array.new if @action_name.nil? invalid_properties.push('invalid value for "action_name", action_name cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
230 231 232 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 230 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 236 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
224 225 226 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 224 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
124 125 126 127 |
# File 'lib/hubspot/codegen/automation/actions/models/action_labels.rb', line 124 def valid? return false if @action_name.nil? true end |