class ConnectWise::ProductRecurring
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/connectwise-ruby-sdk/models/product_recurring.rb, line 44 def self.attribute_map { :'recurring_revenue' => :'recurringRevenue', :'recurring_cost' => :'recurringCost', :'start_date' => :'startDate', :'end_date' => :'endDate', :'bill_cycle_id' => :'billCycleId', :'cycles' => :'cycles', :'cycle_type' => :'cycleType' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/connectwise-ruby-sdk/models/product_recurring.rb, line 71 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?(:'recurringRevenue') self.recurring_revenue = attributes[:'recurringRevenue'] end if attributes.has_key?(:'recurringCost') self.recurring_cost = attributes[:'recurringCost'] end if attributes.has_key?(:'startDate') self.start_date = attributes[:'startDate'] end if attributes.has_key?(:'endDate') self.end_date = attributes[:'endDate'] end if attributes.has_key?(:'billCycleId') self.bill_cycle_id = attributes[:'billCycleId'] end if attributes.has_key?(:'cycles') self.cycles = attributes[:'cycles'] end if attributes.has_key?(:'cycleType') self.cycle_type = attributes[:'cycleType'] end end
Attribute type mapping.
# File lib/connectwise-ruby-sdk/models/product_recurring.rb, line 57 def self.swagger_types { :'recurring_revenue' => :'Float', :'recurring_cost' => :'Float', :'start_date' => :'DateTime', :'end_date' => :'DateTime', :'bill_cycle_id' => :'Integer', :'cycles' => :'Integer', :'cycle_type' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/connectwise-ruby-sdk/models/product_recurring.rb, line 169 def ==(o) return true if self.equal?(o) self.class == o.class && recurring_revenue == o.recurring_revenue && recurring_cost == o.recurring_cost && start_date == o.start_date && end_date == o.end_date && bill_cycle_id == o.bill_cycle_id && cycles == o.cycles && cycle_type == o.cycle_type 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/product_recurring.rb, line 217 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/product_recurring.rb, line 283 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/product_recurring.rb, line 196 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
Custom attribute writer method checking allowed values (enum). @param [Object] cycle_type
Object to be assigned
# File lib/connectwise-ruby-sdk/models/product_recurring.rb, line 159 def cycle_type=(cycle_type) validator = EnumAttributeValidator.new('String', ["CalendarYear", "ContractYear"]) unless validator.valid?(cycle_type) fail ArgumentError, "invalid value for 'cycle_type', must be one of #{validator.allowable_values}." end @cycle_type = cycle_type end
@see the `==` method @param [Object] Object to be compared
# File lib/connectwise-ruby-sdk/models/product_recurring.rb, line 183 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/connectwise-ruby-sdk/models/product_recurring.rb, line 189 def hash [recurring_revenue, recurring_cost, start_date, end_date, bill_cycle_id, cycles, cycle_type].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/product_recurring.rb, line 109 def list_invalid_properties invalid_properties = Array.new if @recurring_revenue.nil? invalid_properties.push("invalid value for 'recurring_revenue', recurring_revenue cannot be nil.") end if @recurring_cost.nil? invalid_properties.push("invalid value for 'recurring_cost', recurring_cost cannot be nil.") end if @start_date.nil? invalid_properties.push("invalid value for 'start_date', start_date cannot be nil.") end if @end_date.nil? invalid_properties.push("invalid value for 'end_date', end_date cannot be nil.") end if @bill_cycle_id.nil? invalid_properties.push("invalid value for 'bill_cycle_id', bill_cycle_id cannot be nil.") end if @cycles.nil? invalid_properties.push("invalid value for 'cycles', cycles cannot be nil.") end if @cycle_type.nil? invalid_properties.push("invalid value for 'cycle_type', cycle_type cannot be nil.") end return invalid_properties 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/product_recurring.rb, line 269 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/product_recurring.rb, line 257 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/connectwise-ruby-sdk/models/product_recurring.rb, line 144 def valid? return false if @recurring_revenue.nil? return false if @recurring_cost.nil? return false if @start_date.nil? return false if @end_date.nil? return false if @bill_cycle_id.nil? return false if @cycles.nil? return false if @cycle_type.nil? cycle_type_validator = EnumAttributeValidator.new('String', ["CalendarYear", "ContractYear"]) return false unless cycle_type_validator.valid?(@cycle_type) return true end