class Hubspot::CommunicationPreferences::PublicSubscriptionStatus
Attributes
The ID of the brand that the subscription is associated with, if there is one.
A description of the subscription.
The ID for the subscription.
The legal reason for the current status of the subscription.
A more detailed explanation to go with the legal basis.
The name of the subscription.
The name of the preferences group that the subscription is associated with.
Where the status is determined from e.g. PORTAL_WIDE_STATUS if the contact opted out from the portal.
Whether the contact is subscribed.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb, line 68 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'description' => :'description', :'status' => :'status', :'source_of_status' => :'sourceOfStatus', :'brand_id' => :'brandId', :'preference_group_name' => :'preferenceGroupName', :'legal_basis' => :'legalBasis', :'legal_basis_explanation' => :'legalBasisExplanation' } 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/communication_preferences/models/public_subscription_status.rb, line 260 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/communication_preferences/models/public_subscription_status.rb, line 105 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::CommunicationPreferences::PublicSubscriptionStatus` 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::CommunicationPreferences::PublicSubscriptionStatus`. 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?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'source_of_status') self.source_of_status = attributes[:'source_of_status'] end if attributes.key?(:'brand_id') self.brand_id = attributes[:'brand_id'] end if attributes.key?(:'preference_group_name') self.preference_group_name = attributes[:'preference_group_name'] end if attributes.key?(:'legal_basis') self.legal_basis = attributes[:'legal_basis'] end if attributes.key?(:'legal_basis_explanation') self.legal_basis_explanation = attributes[:'legal_basis_explanation'] end end
List of attributes with nullable: true
# File lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb, line 98 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb, line 83 def self.openapi_types { :'id' => :'String', :'name' => :'String', :'description' => :'String', :'status' => :'String', :'source_of_status' => :'String', :'brand_id' => :'Integer', :'preference_group_name' => :'String', :'legal_basis' => :'String', :'legal_basis_explanation' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb, line 231 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && description == o.description && status == o.status && source_of_status == o.source_of_status && brand_id == o.brand_id && preference_group_name == o.preference_group_name && legal_basis == o.legal_basis && legal_basis_explanation == o.legal_basis_explanation 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/communication_preferences/models/public_subscription_status.rb, line 288 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::CommunicationPreferences.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/communication_preferences/models/public_subscription_status.rb, line 357 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/communication_preferences/models/public_subscription_status.rb, line 267 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/communication_preferences/models/public_subscription_status.rb, line 247 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb, line 253 def hash [id, name, description, status, source_of_status, brand_id, preference_group_name, legal_basis, legal_basis_explanation].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] legal_basis
Object to be assigned
# File lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb, line 221 def legal_basis=(legal_basis) validator = EnumAttributeValidator.new('String', ["LEGITIMATE_INTEREST_PQL", "LEGITIMATE_INTEREST_CLIENT", "PERFORMANCE_OF_CONTRACT", "CONSENT_WITH_NOTICE", "NON_GDPR", "PROCESS_AND_STORE", "LEGITIMATE_INTEREST_OTHER"]) unless validator.valid?(legal_basis) fail ArgumentError, "invalid value for \"legal_basis\", must be one of #{validator.allowable_values}." end @legal_basis = legal_basis end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb, line 157 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @description.nil? invalid_properties.push('invalid value for "description", description cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @source_of_status.nil? invalid_properties.push('invalid value for "source_of_status", source_of_status cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] source_of_status
Object to be assigned
# File lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb, line 211 def source_of_status=(source_of_status) validator = EnumAttributeValidator.new('String', ["PORTAL_WIDE_STATUS", "BRAND_WIDE_STATUS", "SUBSCRIPTION_STATUS"]) unless validator.valid?(source_of_status) fail ArgumentError, "invalid value for \"source_of_status\", must be one of #{validator.allowable_values}." end @source_of_status = source_of_status end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb, line 201 def status=(status) validator = EnumAttributeValidator.new('String', ["SUBSCRIBED", "NOT_SUBSCRIBED"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb, line 339 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/communication_preferences/models/public_subscription_status.rb, line 327 def to_s to_hash.to_s 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/communication_preferences/models/public_subscription_status.rb, line 184 def valid? return false if @id.nil? return false if @name.nil? return false if @description.nil? return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ["SUBSCRIBED", "NOT_SUBSCRIBED"]) return false unless status_validator.valid?(@status) return false if @source_of_status.nil? source_of_status_validator = EnumAttributeValidator.new('String', ["PORTAL_WIDE_STATUS", "BRAND_WIDE_STATUS", "SUBSCRIPTION_STATUS"]) return false unless source_of_status_validator.valid?(@source_of_status) legal_basis_validator = EnumAttributeValidator.new('String', ["LEGITIMATE_INTEREST_PQL", "LEGITIMATE_INTEREST_CLIENT", "PERFORMANCE_OF_CONTRACT", "CONSENT_WITH_NOTICE", "NON_GDPR", "PROCESS_AND_STORE", "LEGITIMATE_INTEREST_OTHER"]) return false unless legal_basis_validator.valid?(@legal_basis) true end