class Hubspot::Crm::Timeline::BatchResponseTimelineEventResponse

The state of the batch event request.

Attributes

completed_at[RW]

The time the request was completed.

errors[RW]

The events that weren't created.

num_errors[RW]

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

requested_at[RW]

The time the request occurred.

results[RW]

Successfully created events.

started_at[RW]

The time the request began processing.

status[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb, line 90
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb, line 204
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
status=(status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

# File lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb, line 180
def status=(status)
  validator = EnumAttributeValidator.new('String', ["PENDING", "PROCESSING", "CANCELED", "COMPLETE"])
  unless validator.valid?(status)
    fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
  end
  @status = status
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb, line 290
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/hubspot/codegen/crm/timeline/models/batch_response_timeline_event_response.rb, line 284
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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