Class: Hubspot::Crm::Objects::Emails::BatchResponseSimplePublicObject

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchResponseSimplePublicObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 92

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Objects::Emails::BatchResponseSimplePublicObject` 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::Crm::Objects::Emails::BatchResponseSimplePublicObject`. 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?(:'completed_at')
    self.completed_at = attributes[:'completed_at']
  end

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

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

  if attributes.key?(:'links')
    if (value = attributes[:'links']).is_a?(Hash)
      self.links = value
    end
  end

  if attributes.key?(:'results')
    if (value = attributes[:'results']).is_a?(Array)
      self.results = value
    end
  end

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

Instance Attribute Details

#completed_atObject

Returns the value of attribute completed_at.



21
22
23
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 21

def completed_at
  @completed_at
end

Returns the value of attribute links.



27
28
29
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 27

def links
  @links
end

#requested_atObject

Returns the value of attribute requested_at.



23
24
25
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 23

def requested_at
  @requested_at
end

#resultsObject

Returns the value of attribute results.



29
30
31
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 29

def results
  @results
end

#started_atObject

Returns the value of attribute started_at.



25
26
27
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 25

def started_at
  @started_at
end

#statusObject

Returns the value of attribute status.



31
32
33
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 31

def status
  @status
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



68
69
70
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 68

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



56
57
58
59
60
61
62
63
64
65
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 56

def self.attribute_map
  {
    :'completed_at' => :'completedAt',
    :'requested_at' => :'requestedAt',
    :'started_at' => :'startedAt',
    :'links' => :'links',
    :'results' => :'results',
    :'status' => :'status'
  }
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



207
208
209
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 207

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

.openapi_nullableObject

List of attributes with nullable: true



85
86
87
88
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 85

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

.openapi_typesObject

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 73

def self.openapi_types
  {
    :'completed_at' => :'Time',
    :'requested_at' => :'Time',
    :'started_at' => :'Time',
    :'links' => :'Hash<String, String>',
    :'results' => :'Array<SimplePublicObject>',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



181
182
183
184
185
186
187
188
189
190
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      completed_at == o.completed_at &&
      requested_at == o.requested_at &&
      started_at == o.started_at &&
      links == o.links &&
      results == o.results &&
      status == o.status
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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 238

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::Crm::Objects::Emails.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



309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 309

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 214

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


194
195
196
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 194

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



200
201
202
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 200

def hash
  [completed_at, requested_at, started_at, links, results, status].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 136

def list_invalid_properties
  invalid_properties = Array.new
  if @completed_at.nil?
    invalid_properties.push('invalid value for "completed_at", completed_at cannot be nil.')
  end

  if @started_at.nil?
    invalid_properties.push('invalid value for "started_at", started_at cannot be nil.')
  end

  if @results.nil?
    invalid_properties.push('invalid value for "results", results cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



285
286
287
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 285

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 291

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



279
280
281
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 279

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



159
160
161
162
163
164
165
166
167
# File 'lib/hubspot/codegen/crm/objects/emails/models/batch_response_simple_public_object.rb', line 159

def valid?
  return false if @completed_at.nil?
  return false if @started_at.nil?
  return false if @results.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
  return false unless status_validator.valid?(@status)
  true
end