class Bfwd::SingleRecalculateChargeRequest
Request object for recalculating a charge raised against a subscription or invoice.
Attributes
{"description":"(Applicable only if the existing charge has none of [`pricingComponentName`, `pricingComponentID`] defined)
New monetary amount for which to charge. Used only for ad-hoc charges (i.e charges not associated with any pricing component).
This amount excludes tax.","verbs":}
{"description":"New description given to the charge.","verbs":}
{"description":"The unique id of the charge to be recalculated.","verbs":}
{"default":"<span class=\"label label-default\">Aggregated</span>","description":"The strategy for how to raise invoices describing the charges produced by this charge recalculation.
<span class=\"label label-default\">Immediate</span> — Generate straight-away an invoice containing these charges.
<span class=\"label label-default\">Aggregated</span> — Add these charges to the next invoice which is generated naturally — i.e. the invoice raised at the current period's end.","verbs":}
{"description":"New friendly name given to the charge to help identify it.","verbs":}
{"default":"(Auto-populated using your authentication credentials) ID of the organization actioning this request.","description":"ID of the BillForward Organization
within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.","verbs":}
{"description":"(Applicable only if the existing charge has any of [`pricingComponentName`, `pricingComponentID`] defined)
The updated value consumed of the pricing component which this charge concerns.","verbs":}
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/single_recalculate_charge_request.rb, line 65 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'description' => :'description', :'amount' => :'amount', :'invoicing_type' => :'invoicingType', :'pricing_component_value' => :'pricingComponentValue', :'recalculation_behaviour' => :'recalculationBehaviour', :'organization_id' => :'organizationID' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/single_recalculate_charge_request.rb, line 94 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?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'amount') self.amount = attributes[:'amount'] end if attributes.has_key?(:'invoicingType') self.invoicing_type = attributes[:'invoicingType'] end if attributes.has_key?(:'pricingComponentValue') self.pricing_component_value = attributes[:'pricingComponentValue'] end if attributes.has_key?(:'recalculationBehaviour') self.recalculation_behaviour = attributes[:'recalculationBehaviour'] end if attributes.has_key?(:'organizationID') self.organization_id = attributes[:'organizationID'] end end
Attribute type mapping.
# File lib/bf_ruby2/models/single_recalculate_charge_request.rb, line 79 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'description' => :'String', :'amount' => :'Float', :'invoicing_type' => :'String', :'pricing_component_value' => :'Integer', :'recalculation_behaviour' => :'String', :'organization_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/single_recalculate_charge_request.rb, line 183 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && description == o.description && amount == o.amount && invoicing_type == o.invoicing_type && pricing_component_value == o.pricing_component_value && recalculation_behaviour == o.recalculation_behaviour && organization_id == o.organization_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/single_recalculate_charge_request.rb, line 232 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/single_recalculate_charge_request.rb, line 298 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/single_recalculate_charge_request.rb, line 211 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/single_recalculate_charge_request.rb, line 198 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/single_recalculate_charge_request.rb, line 204 def hash [id, name, description, amount, invoicing_type, pricing_component_value, recalculation_behaviour, organization_id].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] invoicing_type
Object to be assigned
# File lib/bf_ruby2/models/single_recalculate_charge_request.rb, line 163 def invoicing_type=(invoicing_type) validator = EnumAttributeValidator.new('String', ["Immediate", "Aggregated"]) unless validator.valid?(invoicing_type) fail ArgumentError, "invalid value for 'invoicing_type', must be one of #{validator.allowable_values}." end @invoicing_type = invoicing_type 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/single_recalculate_charge_request.rb, line 136 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push("invalid value for 'id', id cannot be nil.") end if @recalculation_behaviour.nil? invalid_properties.push("invalid value for 'recalculation_behaviour', recalculation_behaviour cannot be nil.") end return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] recalculation_behaviour
Object to be assigned
# File lib/bf_ruby2/models/single_recalculate_charge_request.rb, line 173 def recalculation_behaviour=(recalculation_behaviour) validator = EnumAttributeValidator.new('String', ["RecalculateWithLatestPricing", "RecalculateWithCurrentPricing"]) unless validator.valid?(recalculation_behaviour) fail ArgumentError, "invalid value for 'recalculation_behaviour', must be one of #{validator.allowable_values}." end @recalculation_behaviour = recalculation_behaviour end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/bf_ruby2/models/single_recalculate_charge_request.rb, line 284 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/single_recalculate_charge_request.rb, line 272 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/single_recalculate_charge_request.rb, line 151 def valid? return false if @id.nil? invoicing_type_validator = EnumAttributeValidator.new('String', ["Immediate", "Aggregated"]) return false unless invoicing_type_validator.valid?(@invoicing_type) return false if @recalculation_behaviour.nil? recalculation_behaviour_validator = EnumAttributeValidator.new('String', ["RecalculateWithLatestPricing", "RecalculateWithCurrentPricing"]) return false unless recalculation_behaviour_validator.valid?(@recalculation_behaviour) return true end