class Pipedrive::InlineObject2

Attributes

activity_id[RW]

If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don't need to specify deal_id, person_id or org_id, as they will be ignored in favor of the values already available in the activity.

deal_id[RW]

When not available, you need to specify at least the person_id or the org_id parameter

end_time[RW]

The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.

from_phone_number[RW]

The number that made the call

org_id[RW]

When not available, you need to specify at least the person_id or the deal_id parameter

outcome[RW]

Describes the outcome of the call

person_id[RW]

When not available, you need to specify at least the org_id or the deal_id parameter

start_time[RW]

The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.

subject[RW]

A title for the log object. If not provided, an automatic subject will be generated.

to_phone_number[RW]

The number called

user_id[RW]

The ID of the owner of the call log

Public Class Methods

attribute_map() click to toggle source

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

# File lib/pipedrive-openapi-client/models/inline_object2.rb, line 73
def self.attribute_map
  {
    :'user_id' => :'user_id',
    :'activity_id' => :'activity_id',
    :'subject' => :'subject',
    :'from_phone_number' => :'from_phone_number',
    :'to_phone_number' => :'to_phone_number',
    :'outcome' => :'outcome',
    :'start_time' => :'start_time',
    :'end_time' => :'end_time',
    :'person_id' => :'person_id',
    :'org_id' => :'org_id',
    :'deal_id' => :'deal_id'
  }
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/pipedrive-openapi-client/models/inline_object2.rb, line 250
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/pipedrive-openapi-client/models/inline_object2.rb, line 114
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Pipedrive::InlineObject2` 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 `Pipedrive::InlineObject2`. 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?(:'user_id')
    self.user_id = attributes[:'user_id']
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'deal_id')
    self.deal_id = attributes[:'deal_id']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/pipedrive-openapi-client/models/inline_object2.rb, line 107
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/pipedrive-openapi-client/models/inline_object2.rb, line 90
def self.openapi_types
  {
    :'user_id' => :'Integer',
    :'activity_id' => :'Integer',
    :'subject' => :'String',
    :'from_phone_number' => :'String',
    :'to_phone_number' => :'String',
    :'outcome' => :'String',
    :'start_time' => :'Date',
    :'end_time' => :'Date',
    :'person_id' => :'Integer',
    :'org_id' => :'Integer',
    :'deal_id' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/pipedrive-openapi-client/models/inline_object2.rb, line 219
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user_id == o.user_id &&
      activity_id == o.activity_id &&
      subject == o.subject &&
      from_phone_number == o.from_phone_number &&
      to_phone_number == o.to_phone_number &&
      outcome == o.outcome &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      person_id == o.person_id &&
      org_id == o.org_id &&
      deal_id == o.deal_id
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/pipedrive-openapi-client/models/inline_object2.rb, line 278
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
    Pipedrive.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/pipedrive-openapi-client/models/inline_object2.rb, line 347
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/pipedrive-openapi-client/models/inline_object2.rb, line 257
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/pipedrive-openapi-client/models/inline_object2.rb, line 237
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/pipedrive-openapi-client/models/inline_object2.rb, line 243
def hash
  [user_id, activity_id, subject, from_phone_number, to_phone_number, outcome, start_time, end_time, person_id, org_id, deal_id].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/pipedrive-openapi-client/models/inline_object2.rb, line 174
def list_invalid_properties
  invalid_properties = Array.new
  if @to_phone_number.nil?
    invalid_properties.push('invalid value for "to_phone_number", to_phone_number cannot be nil.')
  end

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

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

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

  invalid_properties
end
outcome=(outcome) click to toggle source

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

# File lib/pipedrive-openapi-client/models/inline_object2.rb, line 209
def outcome=(outcome)
  validator = EnumAttributeValidator.new('String', ["connected", "no_answer", "left_message", "left_voicemail", "wrong_number", "busy"])
  unless validator.valid?(outcome)
    fail ArgumentError, "invalid value for \"outcome\", must be one of #{validator.allowable_values}."
  end
  @outcome = outcome
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/pipedrive-openapi-client/models/inline_object2.rb, line 323
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/pipedrive-openapi-client/models/inline_object2.rb, line 329
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/pipedrive-openapi-client/models/inline_object2.rb, line 317
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/pipedrive-openapi-client/models/inline_object2.rb, line 197
def valid?
  return false if @to_phone_number.nil?
  return false if @outcome.nil?
  outcome_validator = EnumAttributeValidator.new('String', ["connected", "no_answer", "left_message", "left_voicemail", "wrong_number", "busy"])
  return false unless outcome_validator.valid?(@outcome)
  return false if @start_time.nil?
  return false if @end_time.nil?
  true
end