Class: Hubspot::CommunicationPreferences::PublicSubscriptionStatus
- Inherits:
-
Object
- Object
- Hubspot::CommunicationPreferences::PublicSubscriptionStatus
- Defined in:
- lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#brand_id ⇒ Object
The ID of the brand that the subscription is associated with, if there is one.
-
#description ⇒ Object
A description of the subscription.
-
#id ⇒ Object
The ID for the subscription.
-
#legal_basis ⇒ Object
The legal reason for the current status of the subscription.
-
#legal_basis_explanation ⇒ Object
A more detailed explanation to go with the legal basis.
-
#name ⇒ Object
The name of the subscription.
-
#preference_group_name ⇒ Object
The name of the preferences group that the subscription is associated with.
-
#source_of_status ⇒ Object
Where the status is determined from e.g.
-
#status ⇒ Object
Whether the contact is subscribed.
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 = {}) ⇒ PublicSubscriptionStatus
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 = {}) ⇒ PublicSubscriptionStatus
Initializes the object
105 106 107 108 109 110 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 |
# 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 |
Instance Attribute Details
#brand_id ⇒ Object
The ID of the brand that the subscription is associated with, if there is one.
34 35 36 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 34 def brand_id @brand_id end |
#description ⇒ Object
A description of the subscription.
25 26 27 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 25 def description @description end |
#id ⇒ Object
The ID for the subscription.
19 20 21 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 19 def id @id end |
#legal_basis ⇒ Object
The legal reason for the current status of the subscription.
40 41 42 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 40 def legal_basis @legal_basis end |
#legal_basis_explanation ⇒ Object
A more detailed explanation to go with the legal basis.
43 44 45 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 43 def legal_basis_explanation @legal_basis_explanation end |
#name ⇒ Object
The name of the subscription.
22 23 24 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 22 def name @name end |
#preference_group_name ⇒ Object
The name of the preferences group that the subscription is associated with.
37 38 39 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 37 def preference_group_name @preference_group_name end |
#source_of_status ⇒ Object
Where the status is determined from e.g. PORTAL_WIDE_STATUS if the contact opted out from the portal.
31 32 33 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 31 def source_of_status @source_of_status end |
#status ⇒ Object
Whether the contact is subscribed.
28 29 30 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 28 def status @status end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
68 69 70 71 72 73 74 75 76 77 78 79 80 |
# 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 |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
260 261 262 |
# 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 |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
98 99 100 101 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 98 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
83 84 85 86 87 88 89 90 91 92 93 94 95 |
# 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
231 232 233 234 235 236 237 238 239 240 241 242 243 |
# 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 |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# 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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
357 358 359 360 361 362 363 364 365 366 367 368 369 |
# 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
# 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 |
#eql?(o) ⇒ Boolean
247 248 249 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 247 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
253 254 255 |
# 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 |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# 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 |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
333 334 335 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 333 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
339 340 341 342 343 344 345 346 347 348 349 350 351 |
# 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 |
#to_s ⇒ String
Returns the string representation of the object
327 328 329 |
# File 'lib/hubspot/codegen/communication_preferences/models/public_subscription_status.rb', line 327 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# 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 |