class Pipedrive::BaseNote

Attributes

active_flag[RW]

If Note is active or deleted

add_time[RW]

The creation date and time of the Note

content[RW]

Content of the Note in HTML format. Subject to sanitization on the back-end.

deal[RW]
deal_id[RW]

The ID of the Deal the Note is attached to

id[RW]

The ID of the Note

last_update_user_id[RW]

The ID of the User who updated the Note last

org_id[RW]

The ID of the Organization this Note is attached to

organization[RW]
person[RW]
person_id[RW]

The ID of the Person this Note is attached to

pinned_to_deal_flag[RW]

If true, then the results are filtered by Note to Deal pinning state.

pinned_to_organization_flag[RW]

If true, then the results are filtered by Note to Organization pinning state.

pinned_to_person_flag[RW]

If true, then the results are filtered by Note to Person pinning state.

update_time[RW]

The last updated date and time of the Note

user[RW]
user_id[RW]

The ID of the Note creator

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/base_note.rb, line 65
def self.attribute_map
  {
    :'id' => :'id',
    :'active_flag' => :'active_flag',
    :'add_time' => :'add_time',
    :'content' => :'content',
    :'deal' => :'deal',
    :'deal_id' => :'deal_id',
    :'last_update_user_id' => :'last_update_user_id',
    :'org_id' => :'org_id',
    :'organization' => :'organization',
    :'person' => :'person',
    :'person_id' => :'person_id',
    :'pinned_to_deal_flag' => :'pinned_to_deal_flag',
    :'pinned_to_organization_flag' => :'pinned_to_organization_flag',
    :'pinned_to_person_flag' => :'pinned_to_person_flag',
    :'update_time' => :'update_time',
    :'user' => :'user',
    :'user_id' => :'user_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/base_note.rb, line 252
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/base_note.rb, line 118
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Pipedrive::BaseNote` 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::BaseNote`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/pipedrive-openapi-client/models/base_note.rb, line 88
def self.openapi_types
  {
    :'id' => :'Integer',
    :'active_flag' => :'Boolean',
    :'add_time' => :'String',
    :'content' => :'String',
    :'deal' => :'BaseNoteDealTitle',
    :'deal_id' => :'Integer',
    :'last_update_user_id' => :'Integer',
    :'org_id' => :'Integer',
    :'organization' => :'BaseNoteOrganization',
    :'person' => :'BaseNotePerson',
    :'person_id' => :'Integer',
    :'pinned_to_deal_flag' => :'Boolean',
    :'pinned_to_organization_flag' => :'Boolean',
    :'pinned_to_person_flag' => :'Boolean',
    :'update_time' => :'String',
    :'user' => :'NoteCreatorUser',
    :'user_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/base_note.rb, line 215
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      active_flag == o.active_flag &&
      add_time == o.add_time &&
      content == o.content &&
      deal == o.deal &&
      deal_id == o.deal_id &&
      last_update_user_id == o.last_update_user_id &&
      org_id == o.org_id &&
      organization == o.organization &&
      person == o.person &&
      person_id == o.person_id &&
      pinned_to_deal_flag == o.pinned_to_deal_flag &&
      pinned_to_organization_flag == o.pinned_to_organization_flag &&
      pinned_to_person_flag == o.pinned_to_person_flag &&
      update_time == o.update_time &&
      user == o.user &&
      user_id == o.user_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/base_note.rb, line 280
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/base_note.rb, line 349
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/base_note.rb, line 259
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/base_note.rb, line 239
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/base_note.rb, line 245
def hash
  [id, active_flag, add_time, content, deal, deal_id, last_update_user_id, org_id, organization, person, person_id, pinned_to_deal_flag, pinned_to_organization_flag, pinned_to_person_flag, update_time, user, user_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/base_note.rb, line 202
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
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/base_note.rb, line 325
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/base_note.rb, line 331
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/base_note.rb, line 319
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/base_note.rb, line 209
def valid?
  true
end