class PureCloud::SubscriptionOverviewUsage
Attributes
Quantity multiplier for this charge
UI grouping key
Indicates whether the item is cancellable
A charge from a third party entity
Product charge name
Price for usage / overage charge
Product part number
Price for prepay charge
Items
prepaid for specified period
UI unit of measure
Notes about the usage/charge item
Usage
count for specified period
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 58 def self.attribute_map { :'name' => :'name', :'part_number' => :'partNumber', :'grouping' => :'grouping', :'unit_of_measure_type' => :'unitOfMeasureType', :'usage_quantity' => :'usageQuantity', :'overage_price' => :'overagePrice', :'prepay_quantity' => :'prepayQuantity', :'prepay_price' => :'prepayPrice', :'usage_notes' => :'usageNotes', :'is_cancellable' => :'isCancellable', :'bundle_quantity' => :'bundleQuantity', :'is_third_party' => :'isThirdParty' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 121 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'partNumber') self.part_number = attributes[:'partNumber'] end if attributes.has_key?(:'grouping') self.grouping = attributes[:'grouping'] end if attributes.has_key?(:'unitOfMeasureType') self.unit_of_measure_type = attributes[:'unitOfMeasureType'] end if attributes.has_key?(:'usageQuantity') self.usage_quantity = attributes[:'usageQuantity'] end if attributes.has_key?(:'overagePrice') self.overage_price = attributes[:'overagePrice'] end if attributes.has_key?(:'prepayQuantity') self.prepay_quantity = attributes[:'prepayQuantity'] end if attributes.has_key?(:'prepayPrice') self.prepay_price = attributes[:'prepayPrice'] end if attributes.has_key?(:'usageNotes') self.usage_notes = attributes[:'usageNotes'] end if attributes.has_key?(:'isCancellable') self.is_cancellable = attributes[:'isCancellable'] end if attributes.has_key?(:'bundleQuantity') self.bundle_quantity = attributes[:'bundleQuantity'] end if attributes.has_key?(:'isThirdParty') self.is_third_party = attributes[:'isThirdParty'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 89 def self.swagger_types { :'name' => :'String', :'part_number' => :'String', :'grouping' => :'String', :'unit_of_measure_type' => :'String', :'usage_quantity' => :'String', :'overage_price' => :'String', :'prepay_quantity' => :'String', :'prepay_price' => :'String', :'usage_notes' => :'String', :'is_cancellable' => :'BOOLEAN', :'bundle_quantity' => :'String', :'is_third_party' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 394 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && part_number == o.part_number && grouping == o.grouping && unit_of_measure_type == o.unit_of_measure_type && usage_quantity == o.usage_quantity && overage_price == o.overage_price && prepay_quantity == o.prepay_quantity && prepay_price == o.prepay_price && usage_notes == o.usage_notes && is_cancellable == o.is_cancellable && bundle_quantity == o.bundle_quantity && is_third_party == o.is_third_party end
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 443 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 =~ /^(true|t|yes|y|1)$/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 _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 503 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 the object from hash
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 424 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 413 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 419 def hash [name, part_number, grouping, unit_of_measure_type, usage_quantity, overage_price, prepay_quantity, prepay_price, usage_notes, is_cancellable, bundle_quantity, is_third_party].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 240 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 491 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
# File lib/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 481 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/purecloudplatformclientv2/models/subscription_overview_usage.rb, line 249 def valid? if @name.nil? return false end if @part_number.nil? return false end if @grouping.nil? return false end if @unit_of_measure_type.nil? return false end if @usage_quantity.nil? return false end if @prepay_quantity.nil? return false end end