Class: Hubspot::CommunicationPreferences::SubscriptionDefinition
- Inherits:
-
Object
- Object
- Hubspot::CommunicationPreferences::SubscriptionDefinition
- Defined in:
- lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb
Instance Attribute Summary collapse
-
#communication_method ⇒ Object
The method or technology used to contact.
-
#created_at ⇒ Object
Time at which the definition was created.
-
#description ⇒ Object
A description of the subscription.
-
#id ⇒ Object
The ID of the definition.
-
#is_active ⇒ Object
Whether the definition is active or archived.
-
#is_default ⇒ Object
A subscription definition created by HubSpot.
-
#is_internal ⇒ Object
A default description that is used by some HubSpot tools and cannot be edited.
-
#name ⇒ Object
The name of the subscription.
-
#purpose ⇒ Object
The purpose of this subscription or the department in your organization that uses it.
-
#updated_at ⇒ Object
Time at which the definition was last updated.
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 = {}) ⇒ SubscriptionDefinition
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 = {}) ⇒ SubscriptionDefinition
Initializes the object
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 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 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 88 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::CommunicationPreferences::SubscriptionDefinition` 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::SubscriptionDefinition`. 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?(:'purpose') self.purpose = attributes[:'purpose'] end if attributes.key?(:'communication_method') self.communication_method = attributes[:'communication_method'] end if attributes.key?(:'is_active') self.is_active = attributes[:'is_active'] end if attributes.key?(:'is_default') self.is_default = attributes[:'is_default'] end if attributes.key?(:'is_internal') self.is_internal = attributes[:'is_internal'] end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'updated_at') self.updated_at = attributes[:'updated_at'] end end |
Instance Attribute Details
#communication_method ⇒ Object
The method or technology used to contact.
31 32 33 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 31 def communication_method @communication_method end |
#created_at ⇒ Object
Time at which the definition was created.
43 44 45 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 43 def created_at @created_at end |
#description ⇒ Object
A description of the subscription.
25 26 27 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 25 def description @description end |
#id ⇒ Object
The ID of the definition.
19 20 21 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 19 def id @id end |
#is_active ⇒ Object
Whether the definition is active or archived.
34 35 36 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 34 def is_active @is_active end |
#is_default ⇒ Object
A subscription definition created by HubSpot.
37 38 39 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 37 def is_default @is_default end |
#is_internal ⇒ Object
A default description that is used by some HubSpot tools and cannot be edited.
40 41 42 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 40 def is_internal @is_internal end |
#name ⇒ Object
The name of the subscription.
22 23 24 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 22 def name @name end |
#purpose ⇒ Object
The purpose of this subscription or the department in your organization that uses it.
28 29 30 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 28 def purpose @purpose end |
#updated_at ⇒ Object
Time at which the definition was last updated.
46 47 48 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 46 def updated_at @updated_at end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 49 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'description' => :'description', :'purpose' => :'purpose', :'communication_method' => :'communicationMethod', :'is_active' => :'isActive', :'is_default' => :'isDefault', :'is_internal' => :'isInternal', :'created_at' => :'createdAt', :'updated_at' => :'updatedAt' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
227 228 229 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 227 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
81 82 83 84 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 81 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 65 def self.openapi_types { :'id' => :'String', :'name' => :'String', :'description' => :'String', :'purpose' => :'String', :'communication_method' => :'String', :'is_active' => :'Boolean', :'is_default' => :'Boolean', :'is_internal' => :'Boolean', :'created_at' => :'DateTime', :'updated_at' => :'DateTime' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 197 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && description == o.description && purpose == o.purpose && communication_method == o.communication_method && is_active == o.is_active && is_default == o.is_default && is_internal == o.is_internal && created_at == o.created_at && updated_at == o.updated_at end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 255 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
324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 324 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
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 234 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
214 215 216 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 214 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
220 221 222 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 220 def hash [id, name, description, purpose, communication_method, is_active, is_default, is_internal, created_at, updated_at].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 144 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 @is_active.nil? invalid_properties.push('invalid value for "is_active", is_active cannot be nil.') end if @is_default.nil? invalid_properties.push('invalid value for "is_default", is_default cannot be nil.') end if @is_internal.nil? invalid_properties.push('invalid value for "is_internal", is_internal cannot be nil.') end if @created_at.nil? invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') end if @updated_at.nil? invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
300 301 302 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 300 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 306 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
294 295 296 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 294 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 183 def valid? return false if @id.nil? return false if @name.nil? return false if @description.nil? return false if @is_active.nil? return false if @is_default.nil? return false if @is_internal.nil? return false if @created_at.nil? return false if @updated_at.nil? true end |