class Bfwd::RevenueAttribution
A RevenueAttributions describes a portion of the total cost of an Invoice
, that has been attributed to some billable feature.
Attributes
{"description":"ID of the Account
with which this RevenueAttribution's invoice line is associated.","verbs":}
{"description":"The amount paid — through real money — toward this invoice line.","verbs":}
{"description":"ID of the invoice to which this RevenueAttribution's invoice line belongs.","verbs":}
{"description":"ID of the invoice line whose debt this RevenueAttribution
describes.","verbs":}
{"description":"ID of the Subscription
with which this RevenueAttribution's invoice line is associated.","verbs":}
{ "description" : "ID of the user who last updated the entity.", "verbs":[] }
{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }
{"description":"The currency of the Invoice
from which this RevenueAttribution
was raised — specified by a three-character ISO 4217 currency code.","verbs":}
{"description":"ID of the RevenueAttribution.","verbs":}
{"description":"Consistent ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution
. That is: the top parent of that billed feature.","verbs":}
{"description":"Version ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution
. That is: the top parent of that billed feature.","verbs":}
{"description":"The amount paid — through credit or otherwise — toward this invoice line.","verbs":}
{"description":"ID of the organization associated with the RevenueAttribution.","verbs":}
{"description":"PeriodEnd of the charge with which this RevenueAttribution's invoice line is associated.","verbs":}
{"description":"PeriodStart of the charge with which this RevenueAttribution's invoice line is associated.","verbs":}
{"description":"ID of the PricingComponent
with which this RevenueAttribution's invoice line is associated.","verbs":}
{"description":"Name of the PricingComponent
with which this RevenueAttribution's invoice line is associated.","verbs":}
{"description":"ID of the Product
with which this RevenueAttribution's invoice line is associated.","verbs":}
{"description":"Internal name of the Product
with which this RevenueAttribution's invoice line is associated.","verbs":}
{"description":"Public name of the Product
with which this RevenueAttribution's invoice line is associated.","verbs":}
{"description":"ID of the ProductRatePlan
with which this RevenueAttribution's invoice line is associated.","verbs":}
{"description":"Internal name of the ProductRatePlan
with which this RevenueAttribution's invoice line is associated.","verbs":}
{"description":"Public name of the ProductRatePlan
with which this RevenueAttribution's invoice line is associated.","verbs":}
{"description":"Consistent ID of the Subscription
which pays for this invoice line.","verbs":}
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/revenue_attribution.rb, line 92 def self.attribute_map { :'period_start' => :'periodStart', :'period_end' => :'periodEnd', :'created' => :'created', :'changed_by' => :'changedBy', :'id' => :'id', :'organization_id' => :'organizationID', :'invoice_id' => :'invoiceID', :'invoice_version_id' => :'invoiceVersionID', :'aggregated_invoice_id' => :'aggregatedInvoiceID', :'aggregated_invoice_line_id' => :'aggregatedInvoiceLineID', :'currency' => :'currency', :'nominal_amount' => :'nominalAmount', :'actual_amount' => :'actualAmount', :'pricing_component_id' => :'pricingComponentID', :'pricing_component_name' => :'pricingComponentName', :'product_rate_plan_id' => :'productRatePlanID', :'product_rate_plan_name' => :'productRatePlanName', :'product_rate_plan_name_public' => :'productRatePlanNamePublic', :'product_id' => :'productID', :'product_name' => :'productName', :'product_name_public' => :'productNamePublic', :'aggregated_subscription_id' => :'aggregatedSubscriptionID', :'subscription_id' => :'subscriptionID', :'account_id' => :'accountID' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/revenue_attribution.rb, line 153 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?(:'periodStart') self.period_start = attributes[:'periodStart'] end if attributes.has_key?(:'periodEnd') self.period_end = attributes[:'periodEnd'] end if attributes.has_key?(:'created') self.created = attributes[:'created'] end if attributes.has_key?(:'changedBy') self.changed_by = attributes[:'changedBy'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'organizationID') self.organization_id = attributes[:'organizationID'] end if attributes.has_key?(:'invoiceID') self.invoice_id = attributes[:'invoiceID'] end if attributes.has_key?(:'invoiceVersionID') self.invoice_version_id = attributes[:'invoiceVersionID'] end if attributes.has_key?(:'aggregatedInvoiceID') self.aggregated_invoice_id = attributes[:'aggregatedInvoiceID'] end if attributes.has_key?(:'aggregatedInvoiceLineID') self.aggregated_invoice_line_id = attributes[:'aggregatedInvoiceLineID'] end if attributes.has_key?(:'currency') self.currency = attributes[:'currency'] end if attributes.has_key?(:'nominalAmount') self.nominal_amount = attributes[:'nominalAmount'] end if attributes.has_key?(:'actualAmount') self.actual_amount = attributes[:'actualAmount'] end if attributes.has_key?(:'pricingComponentID') self.pricing_component_id = attributes[:'pricingComponentID'] end if attributes.has_key?(:'pricingComponentName') self.pricing_component_name = attributes[:'pricingComponentName'] end if attributes.has_key?(:'productRatePlanID') self.product_rate_plan_id = attributes[:'productRatePlanID'] end if attributes.has_key?(:'productRatePlanName') self.product_rate_plan_name = attributes[:'productRatePlanName'] end if attributes.has_key?(:'productRatePlanNamePublic') self.product_rate_plan_name_public = attributes[:'productRatePlanNamePublic'] end if attributes.has_key?(:'productID') self.product_id = attributes[:'productID'] end if attributes.has_key?(:'productName') self.product_name = attributes[:'productName'] end if attributes.has_key?(:'productNamePublic') self.product_name_public = attributes[:'productNamePublic'] end if attributes.has_key?(:'aggregatedSubscriptionID') self.aggregated_subscription_id = attributes[:'aggregatedSubscriptionID'] end if attributes.has_key?(:'subscriptionID') self.subscription_id = attributes[:'subscriptionID'] end if attributes.has_key?(:'accountID') self.account_id = attributes[:'accountID'] end end
Attribute type mapping.
# File lib/bf_ruby2/models/revenue_attribution.rb, line 122 def self.swagger_types { :'period_start' => :'DateTime', :'period_end' => :'DateTime', :'created' => :'DateTime', :'changed_by' => :'String', :'id' => :'String', :'organization_id' => :'String', :'invoice_id' => :'String', :'invoice_version_id' => :'String', :'aggregated_invoice_id' => :'String', :'aggregated_invoice_line_id' => :'String', :'currency' => :'String', :'nominal_amount' => :'Float', :'actual_amount' => :'Float', :'pricing_component_id' => :'String', :'pricing_component_name' => :'String', :'product_rate_plan_id' => :'String', :'product_rate_plan_name' => :'String', :'product_rate_plan_name_public' => :'String', :'product_id' => :'String', :'product_name' => :'String', :'product_name_public' => :'String', :'aggregated_subscription_id' => :'String', :'subscription_id' => :'String', :'account_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/revenue_attribution.rb, line 377 def ==(o) return true if self.equal?(o) self.class == o.class && period_start == o.period_start && period_end == o.period_end && created == o.created && changed_by == o.changed_by && id == o.id && organization_id == o.organization_id && invoice_id == o.invoice_id && invoice_version_id == o.invoice_version_id && aggregated_invoice_id == o.aggregated_invoice_id && aggregated_invoice_line_id == o.aggregated_invoice_line_id && currency == o.currency && nominal_amount == o.nominal_amount && actual_amount == o.actual_amount && pricing_component_id == o.pricing_component_id && pricing_component_name == o.pricing_component_name && product_rate_plan_id == o.product_rate_plan_id && product_rate_plan_name == o.product_rate_plan_name && product_rate_plan_name_public == o.product_rate_plan_name_public && product_id == o.product_id && product_name == o.product_name && product_name_public == o.product_name_public && aggregated_subscription_id == o.aggregated_subscription_id && subscription_id == o.subscription_id && account_id == o.account_id 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/bf_ruby2/models/revenue_attribution.rb, line 442 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 = Bfwd.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/bf_ruby2/models/revenue_attribution.rb, line 508 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/bf_ruby2/models/revenue_attribution.rb, line 421 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/bf_ruby2/models/revenue_attribution.rb, line 408 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/revenue_attribution.rb, line 414 def hash [period_start, period_end, created, changed_by, id, organization_id, invoice_id, invoice_version_id, aggregated_invoice_id, aggregated_invoice_line_id, currency, nominal_amount, actual_amount, pricing_component_id, pricing_component_name, product_rate_plan_id, product_rate_plan_name, product_rate_plan_name_public, product_id, product_name, product_name_public, aggregated_subscription_id, subscription_id, account_id].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/bf_ruby2/models/revenue_attribution.rb, line 259 def list_invalid_properties invalid_properties = Array.new if @period_start.nil? invalid_properties.push("invalid value for 'period_start', period_start cannot be nil.") end if @period_end.nil? invalid_properties.push("invalid value for 'period_end', period_end cannot be nil.") end if @organization_id.nil? invalid_properties.push("invalid value for 'organization_id', organization_id cannot be nil.") end if @invoice_id.nil? invalid_properties.push("invalid value for 'invoice_id', invoice_id cannot be nil.") end if @invoice_version_id.nil? invalid_properties.push("invalid value for 'invoice_version_id', invoice_version_id cannot be nil.") end if @aggregated_invoice_id.nil? invalid_properties.push("invalid value for 'aggregated_invoice_id', aggregated_invoice_id cannot be nil.") end if @aggregated_invoice_line_id.nil? invalid_properties.push("invalid value for 'aggregated_invoice_line_id', aggregated_invoice_line_id cannot be nil.") end if @currency.nil? invalid_properties.push("invalid value for 'currency', currency cannot be nil.") end if @nominal_amount.nil? invalid_properties.push("invalid value for 'nominal_amount', nominal_amount cannot be nil.") end if @actual_amount.nil? invalid_properties.push("invalid value for 'actual_amount', actual_amount cannot be nil.") end if @pricing_component_id.nil? invalid_properties.push("invalid value for 'pricing_component_id', pricing_component_id cannot be nil.") end if @pricing_component_name.nil? invalid_properties.push("invalid value for 'pricing_component_name', pricing_component_name cannot be nil.") end if @product_rate_plan_id.nil? invalid_properties.push("invalid value for 'product_rate_plan_id', product_rate_plan_id cannot be nil.") end if @product_rate_plan_name.nil? invalid_properties.push("invalid value for 'product_rate_plan_name', product_rate_plan_name cannot be nil.") end if @product_rate_plan_name_public.nil? invalid_properties.push("invalid value for 'product_rate_plan_name_public', product_rate_plan_name_public cannot be nil.") end if @product_id.nil? invalid_properties.push("invalid value for 'product_id', product_id cannot be nil.") end if @product_name.nil? invalid_properties.push("invalid value for 'product_name', product_name cannot be nil.") end if @product_name_public.nil? invalid_properties.push("invalid value for 'product_name_public', product_name_public cannot be nil.") end if @aggregated_subscription_id.nil? invalid_properties.push("invalid value for 'aggregated_subscription_id', aggregated_subscription_id cannot be nil.") end if @subscription_id.nil? invalid_properties.push("invalid value for 'subscription_id', subscription_id cannot be nil.") end if @account_id.nil? invalid_properties.push("invalid value for 'account_id', account_id 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/bf_ruby2/models/revenue_attribution.rb, line 494 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/bf_ruby2/models/revenue_attribution.rb, line 482 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/bf_ruby2/models/revenue_attribution.rb, line 350 def valid? return false if @period_start.nil? return false if @period_end.nil? return false if @organization_id.nil? return false if @invoice_id.nil? return false if @invoice_version_id.nil? return false if @aggregated_invoice_id.nil? return false if @aggregated_invoice_line_id.nil? return false if @currency.nil? return false if @nominal_amount.nil? return false if @actual_amount.nil? return false if @pricing_component_id.nil? return false if @pricing_component_name.nil? return false if @product_rate_plan_id.nil? return false if @product_rate_plan_name.nil? return false if @product_rate_plan_name_public.nil? return false if @product_id.nil? return false if @product_name.nil? return false if @product_name_public.nil? return false if @aggregated_subscription_id.nil? return false if @subscription_id.nil? return false if @account_id.nil? return true end