Class: Hubspot::Automation::Actions::FieldTypeDefinition
- Inherits:
-
Object
- Object
- Hubspot::Automation::Actions::FieldTypeDefinition
- Defined in:
- lib/hubspot/codegen/automation/actions/models/field_type_definition.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#description ⇒ Object
Returns the value of attribute description.
-
#external_options ⇒ Object
Returns the value of attribute external_options.
-
#external_options_reference_type ⇒ Object
Returns the value of attribute external_options_reference_type.
-
#field_type ⇒ Object
Returns the value of attribute field_type.
-
#help_text ⇒ Object
Returns the value of attribute help_text.
-
#label ⇒ Object
Returns the value of attribute label.
-
#name ⇒ Object
Returns the value of attribute name.
-
#options ⇒ Object
Returns the value of attribute options.
-
#options_url ⇒ Object
Returns the value of attribute options_url.
-
#referenced_object_type ⇒ Object
Returns the value of attribute referenced_object_type.
-
#type ⇒ Object
Returns the value of attribute type.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.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 = {}) ⇒ FieldTypeDefinition
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 = {}) ⇒ FieldTypeDefinition
Initializes the object
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 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 111 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Automation::Actions::FieldTypeDefinition` 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::FieldTypeDefinition`. 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?(:'help_text') self.help_text = attributes[:'help_text'] end if attributes.key?(:'referenced_object_type') self.referenced_object_type = attributes[:'referenced_object_type'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'options') if (value = attributes[:'options']).is_a?(Array) self. = value end end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'external_options_reference_type') self. = attributes[:'external_options_reference_type'] end if attributes.key?(:'label') self.label = attributes[:'label'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'field_type') self.field_type = attributes[:'field_type'] end if attributes.key?(:'options_url') self. = attributes[:'options_url'] end if attributes.key?(:'external_options') self. = attributes[:'external_options'] end end |
Instance Attribute Details
#description ⇒ Object
Returns the value of attribute description.
28 29 30 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 28 def description @description end |
#external_options ⇒ Object
Returns the value of attribute external_options.
40 41 42 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 40 def @external_options end |
#external_options_reference_type ⇒ Object
Returns the value of attribute external_options_reference_type.
30 31 32 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 30 def @external_options_reference_type end |
#field_type ⇒ Object
Returns the value of attribute field_type.
36 37 38 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 36 def field_type @field_type end |
#help_text ⇒ Object
Returns the value of attribute help_text.
20 21 22 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 20 def help_text @help_text end |
#label ⇒ Object
Returns the value of attribute label.
32 33 34 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 32 def label @label end |
#name ⇒ Object
Returns the value of attribute name.
24 25 26 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 24 def name @name end |
#options ⇒ Object
Returns the value of attribute options.
26 27 28 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 26 def @options end |
#options_url ⇒ Object
Returns the value of attribute options_url.
38 39 40 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 38 def @options_url end |
#referenced_object_type ⇒ Object
Returns the value of attribute referenced_object_type.
22 23 24 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 22 def referenced_object_type @referenced_object_type end |
#type ⇒ Object
Returns the value of attribute type.
34 35 36 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 34 def type @type end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
82 83 84 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 82 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 65 def self.attribute_map { :'help_text' => :'helpText', :'referenced_object_type' => :'referencedObjectType', :'name' => :'name', :'options' => :'options', :'description' => :'description', :'external_options_reference_type' => :'externalOptionsReferenceType', :'label' => :'label', :'type' => :'type', :'field_type' => :'fieldType', :'options_url' => :'optionsUrl', :'external_options' => :'externalOptions' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
273 274 275 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 273 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
104 105 106 107 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 104 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 87 def self.openapi_types { :'help_text' => :'String', :'referenced_object_type' => :'String', :'name' => :'String', :'options' => :'Array<Option>', :'description' => :'String', :'external_options_reference_type' => :'String', :'label' => :'String', :'type' => :'String', :'field_type' => :'String', :'options_url' => :'String', :'external_options' => :'Boolean' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 242 def ==(o) return true if self.equal?(o) self.class == o.class && help_text == o.help_text && referenced_object_type == o.referenced_object_type && name == o.name && == o. && description == o.description && == o. && label == o.label && type == o.type && field_type == o.field_type && == o. && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 334 335 336 337 338 339 340 341 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 304 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
375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 375 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
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 280 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
260 261 262 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 260 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
266 267 268 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 266 def hash [help_text, referenced_object_type, name, , description, , label, type, field_type, , ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 173 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @options.nil? invalid_properties.push('invalid value for "options", options cannot be nil.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @external_options.nil? invalid_properties.push('invalid value for "external_options", external_options cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
351 352 353 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 351 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
357 358 359 360 361 362 363 364 365 366 367 368 369 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 357 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
345 346 347 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 345 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/hubspot/codegen/automation/actions/models/field_type_definition.rb', line 196 def valid? referenced_object_type_validator = EnumAttributeValidator.new('String', ["CONTACT", "COMPANY", "DEAL", "ENGAGEMENT", "TICKET", "OWNER", "PRODUCT", "LINE_ITEM", "BET_DELIVERABLE_SERVICE", "CONTENT", "CONVERSATION", "BET_ALERT", "PORTAL", "QUOTE", "FORM_SUBMISSION_INBOUNDDB", "QUOTA", "UNSUBSCRIBE", "COMMUNICATION", "FEEDBACK_SUBMISSION", "ATTRIBUTION", "SALESFORCE_SYNC_ERROR", "RESTORABLE_CRM_OBJECT", "HUB", "LANDING_PAGE", "PRODUCT_OR_FOLDER", "TASK", "FORM", "MARKETING_EMAIL", "AD_ACCOUNT", "AD_CAMPAIGN", "AD_GROUP", "AD", "KEYWORD", "CAMPAIGN", "SOCIAL_CHANNEL", "SOCIAL_POST", "SITE_PAGE", "BLOG_POST", "IMPORT", "EXPORT", "CTA", "TASK_TEMPLATE", "AUTOMATION_PLATFORM_FLOW", "OBJECT_LIST", "NOTE", "MEETING_EVENT", "CALL", "EMAIL", "PUBLISHING_TASK", "CONVERSATION_SESSION", "CONTACT_CREATE_ATTRIBUTION", "INVOICE", "MARKETING_EVENT", "CONVERSATION_INBOX", "CHATFLOW", "MEDIA_BRIDGE", "SEQUENCE", "SEQUENCE_STEP", "FORECAST", "SNIPPET", "TEMPLATE", "DEAL_CREATE_ATTRIBUTION", "QUOTE_TEMPLATE", "QUOTE_MODULE", "QUOTE_MODULE_FIELD", "QUOTE_FIELD", "SEQUENCE_ENROLLMENT", "SUBSCRIPTION", "ACCEPTANCE_TEST", "SOCIAL_BROADCAST", "DEAL_SPLIT", "DEAL_REGISTRATION", "GOAL_TARGET", "GOAL_TARGET_GROUP", "PORTAL_OBJECT_SYNC_MESSAGE", "FILE_MANAGER_FILE", "FILE_MANAGER_FOLDER", "SEQUENCE_STEP_ENROLLMENT", "APPROVAL", "APPROVAL_STEP", "CTA_VARIANT", "SALES_DOCUMENT", "DISCOUNT", "FEE", "TAX", "MARKETING_CALENDAR", "PERMISSIONS_TESTING", "PRIVACY_SCANNER_COOKIE", "DATA_SYNC_STATE", "WEB_INTERACTIVE", "PLAYBOOK", "FOLDER", "PLAYBOOK_QUESTION", "PLAYBOOK_SUBMISSION", "PLAYBOOK_SUBMISSION_ANSWER", "COMMERCE_PAYMENT", "GSC_PROPERTY", "SOX_PROTECTED_DUMMY_TYPE", "BLOG_LISTING_PAGE", "QUARANTINED_SUBMISSION", "PAYMENT_SCHEDULE", "PAYMENT_SCHEDULE_INSTALLMENT", "MARKETING_CAMPAIGN_UTM", "DISCOUNT_TEMPLATE", "DISCOUNT_CODE", "FEEDBACK_SURVEY", "CMS_URL", "SALES_TASK", "SALES_WORKLOAD", "USER", "POSTAL_MAIL", "SCHEMAS_BACKEND_TEST", "PAYMENT_LINK", "SUBMISSION_TAG", "CAMPAIGN_STEP", "SCHEDULING_PAGE", "SOX_PROTECTED_TEST_TYPE", "ORDER", "MARKETING_SMS", "PARTNER_ACCOUNT", "CAMPAIGN_TEMPLATE", "CAMPAIGN_TEMPLATE_STEP", "PLAYLIST", "CLIP", "CAMPAIGN_BUDGET_ITEM", "CAMPAIGN_SPEND_ITEM", "MIC", "CONTENT_AUDIT", "CONTENT_AUDIT_PAGE", "PLAYLIST_FOLDER", "LEAD", "ABANDONED_CART", "EXTERNAL_WEB_URL", "VIEW", "VIEW_BLOCK", "ROSTER", "CART", "AUTOMATION_PLATFORM_FLOW_ACTION", "SOCIAL_PROFILE", "PARTNER_CLIENT", "ROSTER_MEMBER", "MARKETING_EVENT_ATTENDANCE", "ALL_PAGES", "AI_FORECAST", "CRM_PIPELINES_DUMMY_TYPE", "KNOWLEDGE_ARTICLE", "PROPERTY_INFO", "DATA_PRIVACY_CONSENT", "GOAL_TEMPLATE", "SCORE_CONFIGURATION", "AUDIENCE", "PARTNER_CLIENT_REVENUE", "AUTOMATION_JOURNEY", "UNKNOWN"]) return false unless referenced_object_type_validator.valid?(@referenced_object_type) return false if @name.nil? return false if @options.nil? return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ["string", "number", "bool", "datetime", "enumeration", "date", "phone_number", "currency_number", "json", "object_coordinates"]) return false unless type_validator.valid?(@type) field_type_validator = EnumAttributeValidator.new('String', ["booleancheckbox", "checkbox", "date", "file", "number", "phonenumber", "radio", "select", "text", "textarea", "calculation_equation", "calculation_rollup", "calculation_score", "calculation_read_time", "unknown", "html"]) return false unless field_type_validator.valid?(@field_type) return false if @external_options.nil? true end |