class Pipedrive::FileData

The File data

Attributes

active_flag[RW]

Whether the User is active or not. false = Not activated, true = Activated

activity_id[RW]

The ID of the Activity to associate the File with

add_time[RW]

The date and time when the File was added/created. Format: YYYY-MM-DD HH:MM:SS

cid[RW]

The ID of the inline attachment

deal_id[RW]

The ID of the Deal to associate the File with

deal_name[RW]

The name of the Deal associated with the File

description[RW]

The description of the File

file_name[RW]

The original name of the File

file_size[RW]

The size of the File

id[RW]

The ID of the File

inline_flag[RW]

Whether the File was uploaded as inline or not

mail_message_id[RW]

The ID of the mail message to associate the File with

mail_template_id[RW]

The ID of the mail template to associate the File with

name[RW]

The visible name of the File

org_id[RW]

The ID of the Organization to associate the File with

org_name[RW]

The name of the Organization associated with the File

person_id[RW]

The ID of the Person to associate the File with

person_name[RW]

The name of the Person associated with the File

product_id[RW]

The ID of the Product to associate the File with

product_name[RW]

The name of the Product associated with the File

remote_id[RW]

The ID of the remote item

remote_location[RW]

The location type to send the File to. Only googledrive is supported at the moment.

s3_bucket[RW]

The location of the cloud storage

update_time[RW]

The last updated date and time of the File. Format: YYYY-MM-DD HH:MM:SS

url[RW]

The URL of the download File

user_id[RW]

The ID of the User to associate the File with

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/file_data.rb, line 97
def self.attribute_map
  {
    :'id' => :'id',
    :'user_id' => :'user_id',
    :'deal_id' => :'deal_id',
    :'person_id' => :'person_id',
    :'org_id' => :'org_id',
    :'product_id' => :'product_id',
    :'activity_id' => :'activity_id',
    :'add_time' => :'add_time',
    :'update_time' => :'update_time',
    :'file_name' => :'file_name',
    :'file_size' => :'file_size',
    :'active_flag' => :'active_flag',
    :'inline_flag' => :'inline_flag',
    :'remote_location' => :'remote_location',
    :'remote_id' => :'remote_id',
    :'cid' => :'cid',
    :'s3_bucket' => :'s3_bucket',
    :'mail_message_id' => :'mail_message_id',
    :'mail_template_id' => :'mail_template_id',
    :'deal_name' => :'deal_name',
    :'person_name' => :'person_name',
    :'org_name' => :'org_name',
    :'product_name' => :'product_name',
    :'url' => :'url',
    :'name' => :'name',
    :'description' => :'description'
  }
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/file_data.rb, line 347
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/file_data.rb, line 168
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Pipedrive::FileData` 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::FileData`. 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?(:'user_id')
    self.user_id = attributes[:'user_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/pipedrive-openapi-client/models/file_data.rb, line 129
def self.openapi_types
  {
    :'id' => :'Integer',
    :'user_id' => :'Integer',
    :'deal_id' => :'Integer',
    :'person_id' => :'Integer',
    :'org_id' => :'Integer',
    :'product_id' => :'Integer',
    :'activity_id' => :'Integer',
    :'add_time' => :'String',
    :'update_time' => :'String',
    :'file_name' => :'String',
    :'file_size' => :'String',
    :'active_flag' => :'Boolean',
    :'inline_flag' => :'Boolean',
    :'remote_location' => :'String',
    :'remote_id' => :'String',
    :'cid' => :'String',
    :'s3_bucket' => :'String',
    :'mail_message_id' => :'String',
    :'mail_template_id' => :'String',
    :'deal_name' => :'String',
    :'person_name' => :'String',
    :'org_name' => :'String',
    :'product_name' => :'String',
    :'url' => :'String',
    :'name' => :'String',
    :'description' => :'String'
  }
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/file_data.rb, line 301
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user_id == o.user_id &&
      deal_id == o.deal_id &&
      person_id == o.person_id &&
      org_id == o.org_id &&
      product_id == o.product_id &&
      activity_id == o.activity_id &&
      add_time == o.add_time &&
      update_time == o.update_time &&
      file_name == o.file_name &&
      file_size == o.file_size &&
      active_flag == o.active_flag &&
      inline_flag == o.inline_flag &&
      remote_location == o.remote_location &&
      remote_id == o.remote_id &&
      cid == o.cid &&
      s3_bucket == o.s3_bucket &&
      mail_message_id == o.mail_message_id &&
      mail_template_id == o.mail_template_id &&
      deal_name == o.deal_name &&
      person_name == o.person_name &&
      org_name == o.org_name &&
      product_name == o.product_name &&
      url == o.url &&
      name == o.name &&
      description == o.description
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/file_data.rb, line 375
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/file_data.rb, line 444
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/file_data.rb, line 354
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/file_data.rb, line 334
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/file_data.rb, line 340
def hash
  [id, user_id, deal_id, person_id, org_id, product_id, activity_id, add_time, update_time, file_name, file_size, active_flag, inline_flag, remote_location, remote_id, cid, s3_bucket, mail_message_id, mail_template_id, deal_name, person_name, org_name, product_name, url, name, description].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/file_data.rb, line 288
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/file_data.rb, line 420
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/file_data.rb, line 426
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/file_data.rb, line 414
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/file_data.rb, line 295
def valid?
  true
end