class Pipedrive::BasicDeal
Attributes
Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.
Optional message about why the deal was lost (to be used when status=lost)
ID of the organization this deal will be associated with
ID of the person this deal will be associated with
Deal success probability percentage. Used/shown only when deal_probability for the pipeline of the deal is enabled.
ID of the stage this deal will be placed in a pipeline (note that you can't supply the ID of the pipeline as this will be assigned automatically based on stage_id
). If omitted, the deal will be placed in the first stage of the default pipeline.
open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open.
Deal title
ID of the user who will be marked as the owner of this deal. If omitted, the authorized user ID will be used.
Value of the deal. If omitted, value will be set to 0.
Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user.<dl class="fields-list"><dt>1</dt><dd>Owner & followers (private)</dd><dt>3</dt><dd>Entire company (shared)</dd></dl>
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/pipedrive-openapi-client/models/basic_deal.rb, line 73 def self.attribute_map { :'title' => :'title', :'value' => :'value', :'currency' => :'currency', :'user_id' => :'user_id', :'person_id' => :'person_id', :'org_id' => :'org_id', :'stage_id' => :'stage_id', :'status' => :'status', :'probability' => :'probability', :'lost_reason' => :'lost_reason', :'visible_to' => :'visible_to' } end
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/basic_deal.rb, line 230 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/pipedrive-openapi-client/models/basic_deal.rb, line 114 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Pipedrive::BasicDeal` 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::BasicDeal`. 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?(:'title') self.title = attributes[:'title'] end if attributes.key?(:'value') self.value = attributes[:'value'] end if attributes.key?(:'currency') self.currency = attributes[:'currency'] end if attributes.key?(:'user_id') self.user_id = attributes[:'user_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?(:'stage_id') self.stage_id = attributes[:'stage_id'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'probability') self.probability = attributes[:'probability'] end if attributes.key?(:'lost_reason') self.lost_reason = attributes[:'lost_reason'] end if attributes.key?(:'visible_to') self.visible_to = attributes[:'visible_to'] end end
List of attributes with nullable: true
# File lib/pipedrive-openapi-client/models/basic_deal.rb, line 107 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/pipedrive-openapi-client/models/basic_deal.rb, line 90 def self.openapi_types { :'title' => :'String', :'value' => :'String', :'currency' => :'String', :'user_id' => :'Integer', :'person_id' => :'Integer', :'org_id' => :'Integer', :'stage_id' => :'Integer', :'status' => :'String', :'probability' => :'Float', :'lost_reason' => :'String', :'visible_to' => :'VisibleTo' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/pipedrive-openapi-client/models/basic_deal.rb, line 199 def ==(o) return true if self.equal?(o) self.class == o.class && title == o.title && value == o.value && currency == o.currency && user_id == o.user_id && person_id == o.person_id && org_id == o.org_id && stage_id == o.stage_id && status == o.status && probability == o.probability && lost_reason == o.lost_reason && visible_to == o.visible_to end
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/basic_deal.rb, line 258 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
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/basic_deal.rb, line 327 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
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/basic_deal.rb, line 237 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
@see the `==` method @param [Object] Object to be compared
# File lib/pipedrive-openapi-client/models/basic_deal.rb, line 217 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/pipedrive-openapi-client/models/basic_deal.rb, line 223 def hash [title, value, currency, user_id, person_id, org_id, stage_id, status, probability, lost_reason, visible_to].hash end
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/basic_deal.rb, line 174 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/pipedrive-openapi-client/models/basic_deal.rb, line 189 def status=(status) validator = EnumAttributeValidator.new('String', ["open", "won", "lost", "deleted"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/pipedrive-openapi-client/models/basic_deal.rb, line 309 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/pipedrive-openapi-client/models/basic_deal.rb, line 297 def to_s to_hash.to_s end
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/basic_deal.rb, line 181 def valid? status_validator = EnumAttributeValidator.new('String', ["open", "won", "lost", "deleted"]) return false unless status_validator.valid?(@status) true end