class Bfwd::Period
Billing period
Attributes
{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }
{ "description" : "Organization associated with this billing period.", "verbs":["POST","PUT","GET"] }
{ "description" : "The incarnation of the subscription to which this billing period refers. The first incarnation of the subscription is in 'period 0'. A recurring subscription may enter 'period 1' and further.", "verbs":["POST","PUT","GET"] }
{ "description" : "The start date of this billing period, UTC DateTime", "verbs":["POST","PUT","GET"] }
{ "description" : "The current state of this billing period. Initially a period is '", "verbs":["POST","PUT","GET"] }ACTIVE_STATE'. Once the 'stop' date is passed, the billing period becomes HISTORIC_STATE.
{ "description" : "The end date of this billing period, UTC DateTime", "verbs":["POST","PUT","GET"] }
{ "description" : "ID of the subscription to which this billing period pertains.", "verbs":["POST","PUT","GET"] }
{ "description" : "The type of usage measured within this billing period. Options are '", "verbs":["POST","PUT","GET"] }Temporal which refers to time-based usage and Itemized, which refers to one-off usages.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/period.rb, line 67 def self.attribute_map { :'created' => :'created', :'subscription_id' => :'subscriptionID', :'organization_id' => :'organizationID', :'invoice_id' => :'invoiceID', :'state' => :'state', :'period' => :'period', :'start' => :'start', :'stop' => :'stop', :'usage_type' => :'usageType' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/period.rb, line 98 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?(:'created') self.created = attributes[:'created'] end if attributes.has_key?(:'subscriptionID') self.subscription_id = attributes[:'subscriptionID'] 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?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'period') self.period = attributes[:'period'] end if attributes.has_key?(:'start') self.start = attributes[:'start'] end if attributes.has_key?(:'stop') self.stop = attributes[:'stop'] end if attributes.has_key?(:'usageType') self.usage_type = attributes[:'usageType'] end end
Attribute type mapping.
# File lib/bf_ruby2/models/period.rb, line 82 def self.swagger_types { :'created' => :'DateTime', :'subscription_id' => :'String', :'organization_id' => :'String', :'invoice_id' => :'String', :'state' => :'String', :'period' => :'Integer', :'start' => :'DateTime', :'stop' => :'DateTime', :'usage_type' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/period.rb, line 211 def ==(o) return true if self.equal?(o) self.class == o.class && created == o.created && subscription_id == o.subscription_id && organization_id == o.organization_id && invoice_id == o.invoice_id && state == o.state && period == o.period && start == o.start && stop == o.stop && usage_type == o.usage_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/bf_ruby2/models/period.rb, line 261 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/period.rb, line 327 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/period.rb, line 240 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/period.rb, line 227 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/period.rb, line 233 def hash [created, subscription_id, organization_id, invoice_id, state, period, start, stop, usage_type].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/period.rb, line 144 def list_invalid_properties invalid_properties = Array.new if @subscription_id.nil? invalid_properties.push("invalid value for 'subscription_id', subscription_id cannot be nil.") end if @organization_id.nil? invalid_properties.push("invalid value for 'organization_id', organization_id cannot be nil.") end if @state.nil? invalid_properties.push("invalid value for 'state', state cannot be nil.") end if @period.nil? invalid_properties.push("invalid value for 'period', period cannot be nil.") end if @start.nil? invalid_properties.push("invalid value for 'start', start cannot be nil.") end if @usage_type.nil? invalid_properties.push("invalid value for 'usage_type', usage_type cannot be nil.") end return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/bf_ruby2/models/period.rb, line 191 def state=(state) validator = EnumAttributeValidator.new('String', ["Active", "Historic"]) unless validator.valid?(state) fail ArgumentError, "invalid value for 'state', must be one of #{validator.allowable_values}." end @state = state end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/bf_ruby2/models/period.rb, line 313 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/period.rb, line 301 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] usage_type
Object to be assigned
# File lib/bf_ruby2/models/period.rb, line 201 def usage_type=(usage_type) validator = EnumAttributeValidator.new('String', ["Temporal", "Itemized"]) unless validator.valid?(usage_type) fail ArgumentError, "invalid value for 'usage_type', must be one of #{validator.allowable_values}." end @usage_type = usage_type 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/period.rb, line 175 def valid? return false if @subscription_id.nil? return false if @organization_id.nil? return false if @state.nil? state_validator = EnumAttributeValidator.new('String', ["Active", "Historic"]) return false unless state_validator.valid?(@state) return false if @period.nil? return false if @start.nil? return false if @usage_type.nil? usage_type_validator = EnumAttributeValidator.new('String', ["Temporal", "Itemized"]) return false unless usage_type_validator.valid?(@usage_type) return true end