Class: Hubspot::Crm::Timeline::BatchResponseTimelineEventResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb

Overview

The state of the batch event request.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchResponseTimelineEventResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 97

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

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

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

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

Instance Attribute Details

#completed_at ⇒ Object

The time the request was completed.



39
40
41
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 39

def completed_at
  @completed_at
end

#errors ⇒ Object

The events that weren’t created.



27
28
29
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 27

def errors
  @errors
end

#num_errors ⇒ Object

The number of events that weren’t created because of an error.



24
25
26
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 24

def num_errors
  @num_errors
end

#requested_at ⇒ Object

The time the request occurred.



33
34
35
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 33

def requested_at
  @requested_at
end

#results ⇒ Object

Successfully created events.



21
22
23
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 21

def results
  @results
end

#started_at ⇒ Object

The time the request began processing.



36
37
38
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 36

def started_at
  @started_at
end

#status ⇒ Object

The status of the batch response. Should always be COMPLETED if processed.



30
31
32
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 30

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 64

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



217
218
219
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 217

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 90

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 77

def self.openapi_types
  {
    :'results' => :'Array<TimelineEventResponse>',
    :'num_errors' => :'Integer',
    :'errors' => :'Array<Error>',
    :'status' => :'String',
    :'requested_at' => :'DateTime',
    :'started_at' => :'DateTime',
    :'completed_at' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 190

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



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
276
277
278
279
280
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 245

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::Crm::Timeline.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 314

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 224

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


204
205
206
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



210
211
212
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 210

def hash
  [results, num_errors, errors, status, requested_at, started_at, completed_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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  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

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

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



290
291
292
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 290

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 296

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



284
285
286
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 284

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



168
169
170
171
172
173
174
175
176
 
# File 'lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb', line 168

def valid?
  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)
  return false if @started_at.nil?
  return false if @completed_at.nil?
  true
end