Class: Hubspot::CommunicationPreferences::SubscriptionDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionDefinition

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
141
142
143
144
145
146
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 94

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?(:'is_internal')
    self.is_internal = attributes[:'is_internal']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'is_default')
    self.is_default = attributes[:'is_default']
  end

  if attributes.key?(:'communication_method')
    self.communication_method = attributes[:'communication_method']
  end

  if attributes.key?(:'purpose')
    self.purpose = attributes[:'purpose']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'is_active')
    self.is_active = attributes[:'is_active']
  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.



29
30
31
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 29

def communication_method
  @communication_method
end

#created_at ⇒ Object

Time at which the definition was created.



23
24
25
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 23

def created_at
  @created_at
end

#description ⇒ Object

A description of the subscription.



38
39
40
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 38

def description
  @description
end

#id ⇒ Object

The ID of the definition.



41
42
43
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 41

def id
  @id
end

#is_active ⇒ Object

Whether the definition is active or archived.



44
45
46
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 44

def is_active
  @is_active
end

#is_default ⇒ Object

A subscription definition created by HubSpot.



26
27
28
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 26

def is_default
  @is_default
end

#is_internal ⇒ Object

A default description that is used by some HubSpot tools and cannot be edited.



20
21
22
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 20

def is_internal
  @is_internal
end

#name ⇒ Object

The name of the subscription.



35
36
37
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 35

def name
  @name
end

#purpose ⇒ Object

The purpose of this subscription or the department in your organization that uses it.



32
33
34
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 32

def purpose
  @purpose
end

#updated_at ⇒ Object

Time at which the definition was last updated.



47
48
49
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 47

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 50

def self.attribute_map
  {
    :'is_internal' => :'isInternal',
    :'created_at' => :'createdAt',
    :'is_default' => :'isDefault',
    :'communication_method' => :'communicationMethod',
    :'purpose' => :'purpose',
    :'name' => :'name',
    :'description' => :'description',
    :'id' => :'id',
    :'is_active' => :'isActive',
    :'updated_at' => :'updatedAt'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



233
234
235
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 233

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 87

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 71

def self.openapi_types
  {
    :'is_internal' => :'Boolean',
    :'created_at' => :'Time',
    :'is_default' => :'Boolean',
    :'communication_method' => :'String',
    :'purpose' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'id' => :'String',
    :'is_active' => :'Boolean',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      is_internal == o.is_internal &&
      created_at == o.created_at &&
      is_default == o.is_default &&
      communication_method == o.communication_method &&
      purpose == o.purpose &&
      name == o.name &&
      description == o.description &&
      id == o.id &&
      is_active == o.is_active &&
      updated_at == o.updated_at
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 264

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::CommunicationPreferences.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 335

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 240

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


220
221
222
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 226

def hash
  [is_internal, created_at, is_default, communication_method, purpose, name, description, id, is_active, updated_at].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
180
181
182
183
184
185
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 150

def list_invalid_properties
  invalid_properties = Array.new
  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 @is_default.nil?
    invalid_properties.push('invalid value for "is_default", is_default 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 @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @is_active.nil?
    invalid_properties.push('invalid value for "is_active", is_active 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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



311
312
313
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 311

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 317

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

Returns:

  • (String) —

    String presentation of the object



305
306
307
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 305

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/hubspot/codegen/communication_preferences/models/subscription_definition.rb', line 189

def valid?
  return false if @is_internal.nil?
  return false if @created_at.nil?
  return false if @is_default.nil?
  return false if @name.nil?
  return false if @description.nil?
  return false if @id.nil?
  return false if @is_active.nil?
  return false if @updated_at.nil?
  true
end