class ConnectWise::Forecast
Attributes
Metadata
of the entity
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 59 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'revenue' => :'revenue', :'cost' => :'cost', :'type' => :'type', :'status' => :'status', :'included_flag' => :'includedFlag', :'recurring' => :'recurring', :'percent' => :'percent', :'margin' => :'margin', :'opportunity_id' => :'opportunityId', :'quote_number' => :'QuoteNumber', :'quote_name' => :'QuoteName', :'_info' => :'_info' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 100 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'revenue') self.revenue = attributes[:'revenue'] end if attributes.has_key?(:'cost') self.cost = attributes[:'cost'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'includedFlag') self.included_flag = attributes[:'includedFlag'] end if attributes.has_key?(:'recurring') self.recurring = attributes[:'recurring'] end if attributes.has_key?(:'percent') self.percent = attributes[:'percent'] end if attributes.has_key?(:'margin') self.margin = attributes[:'margin'] end if attributes.has_key?(:'opportunityId') self.opportunity_id = attributes[:'opportunityId'] end if attributes.has_key?(:'QuoteNumber') self.quote_number = attributes[:'QuoteNumber'] end if attributes.has_key?(:'QuoteName') self.quote_name = attributes[:'QuoteName'] end if attributes.has_key?(:'_info') self._info = attributes[:'_info'] end end
Attribute type mapping.
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 79 def self.swagger_types { :'id' => :'Integer', :'name' => :'String', :'revenue' => :'Float', :'cost' => :'Float', :'type' => :'String', :'status' => :'OpportunityStatusReference', :'included_flag' => :'BOOLEAN', :'recurring' => :'ProductRecurring', :'percent' => :'Float', :'margin' => :'Float', :'opportunity_id' => :'Integer', :'quote_number' => :'String', :'quote_name' => :'String', :'_info' => :'Metadata' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 244 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && revenue == o.revenue && cost == o.cost && type == o.type && status == o.status && included_flag == o.included_flag && recurring == o.recurring && percent == o.percent && margin == o.margin && opportunity_id == o.opportunity_id && quote_number == o.quote_number && quote_name == o.quote_name && _info == o._info 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/connectwise-ruby-sdk/models/forecast.rb, line 299 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 temp_model = ConnectWise.const_get(type).new temp_model.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/connectwise-ruby-sdk/models/forecast.rb, line 365 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/connectwise-ruby-sdk/models/forecast.rb, line 278 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the 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/connectwise-ruby-sdk/models/forecast.rb, line 265 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 271 def hash [id, name, revenue, cost, type, status, included_flag, recurring, percent, margin, opportunity_id, quote_number, quote_name, _info].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 166 def list_invalid_properties invalid_properties = Array.new if !@name.nil? && @name.to_s.length > 50 invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 50.") end if @type.nil? invalid_properties.push("invalid value for 'type', type cannot be nil.") end if !@quote_number.nil? && @quote_number.to_s.length > 20 invalid_properties.push("invalid value for 'quote_number', the character length must be smaller than or equal to 20.") end if !@quote_name.nil? && @quote_name.to_s.length > 255 invalid_properties.push("invalid value for 'quote_name', the character length must be smaller than or equal to 255.") end return invalid_properties end
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 201 def name=(name) if !name.nil? && name.to_s.length > 50 fail ArgumentError, "invalid value for 'name', the character length must be smaller than or equal to 50." end @name = name end
Custom attribute writer method with validation @param [Object] quote_name
Value to be assigned
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 233 def quote_name=(quote_name) if !quote_name.nil? && quote_name.to_s.length > 255 fail ArgumentError, "invalid value for 'quote_name', the character length must be smaller than or equal to 255." end @quote_name = quote_name end
Custom attribute writer method with validation @param [Object] quote_number
Value to be assigned
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 222 def quote_number=(quote_number) if !quote_number.nil? && quote_number.to_s.length > 20 fail ArgumentError, "invalid value for 'quote_number', the character length must be smaller than or equal to 20." end @quote_number = quote_number end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 351 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 339 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 212 def type=(type) validator = EnumAttributeValidator.new('String', ["Product", "Service", "Agreement", "Other1", "Other2"]) unless validator.valid?(type) fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}." end @type = type end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/connectwise-ruby-sdk/models/forecast.rb, line 189 def valid? return false if !@name.nil? && @name.to_s.length > 50 return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ["Product", "Service", "Agreement", "Other1", "Other2"]) return false unless type_validator.valid?(@type) return false if !@quote_number.nil? && @quote_number.to_s.length > 20 return false if !@quote_name.nil? && @quote_name.to_s.length > 255 return true end