class Hubspot::Automation::Actions::FieldTypeDefinition
Attributes
Controls how the field appears in HubSpot.
The input field name.
A list of valid options for the field value.
A URL that will accept HTTPS requests when the valid options for the field are fetched.
This can be set to `OWNER` if the field should contain a HubSpot owner value.
The data type of the field.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 60 def self.attribute_map { :'name' => :'name', :'type' => :'type', :'field_type' => :'fieldType', :'options' => :'options', :'options_url' => :'optionsUrl', :'referenced_object_type' => :'referencedObjectType' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 223 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 91 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?(:'name') self.name = attributes[:'name'] 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') if (value = attributes[:'options']).is_a?(Array) self.options = value end end if attributes.key?(:'options_url') self.options_url = attributes[:'options_url'] end if attributes.key?(:'referenced_object_type') self.referenced_object_type = attributes[:'referenced_object_type'] end end
List of attributes with nullable: true
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 84 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 72 def self.openapi_types { :'name' => :'String', :'type' => :'String', :'field_type' => :'String', :'options' => :'Array<Option>', :'options_url' => :'String', :'referenced_object_type' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 197 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && type == o.type && field_type == o.field_type && options == o.options && options_url == o.options_url && referenced_object_type == o.referenced_object_type end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 251 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 320 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 230 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
@see the `==` method @param [Object] Object to be compared
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 210 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] field_type
Object to be assigned
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 177 def field_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"]) unless validator.valid?(field_type) fail ArgumentError, "invalid value for \"field_type\", must be one of #{validator.allowable_values}." end @field_type = field_type end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 216 def hash [name, type, field_type, options, options_url, referenced_object_type].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 133 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @options.nil? invalid_properties.push('invalid value for "options", options cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] referenced_object_type
Object to be assigned
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 187 def referenced_object_type=(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", "UNKNOWN"]) unless validator.valid?(referenced_object_type) fail ArgumentError, "invalid value for \"referenced_object_type\", must be one of #{validator.allowable_values}." end @referenced_object_type = referenced_object_type end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 302 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 290 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 167 def type=(type) validator = EnumAttributeValidator.new('String', ["string", "number", "bool", "datetime", "enumeration", "date", "phone_number", "currency_number", "json", "object_coordinates"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/hubspot/codegen/automation/actions/models/field_type_definition.rb, line 152 def valid? return false if @name.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"]) return false unless field_type_validator.valid?(@field_type) return false if @options.nil? 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", "UNKNOWN"]) return false unless referenced_object_type_validator.valid?(@referenced_object_type) true end