class XeroRuby::AppStore::Subscription
Attributes
End of the current period that the subscription has been invoiced for.
If the subscription has been canceled, this is the date when the subscription ends. If null, the subscription is active and has not been cancelled
The unique identifier of the subscription
The Xero generated unique identifier for the organisation
List of plans for the subscription.
Date when the subscription was first created.
Status of the subscription. Available statuses are ACTIVE, CANCELED, and PAST_DUE.
Boolean used to indicate if the subscription is in test mode
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/xero-ruby/models/app_store/subscription.rb, line 44 def self.attribute_map { :'current_period_end' => :'currentPeriodEnd', :'end_date' => :'endDate', :'id' => :'id', :'organisation_id' => :'organisationId', :'plans' => :'plans', :'start_date' => :'startDate', :'status' => :'status', :'test_mode' => :'testMode' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/xero-ruby/models/app_store/subscription.rb, line 194 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/xero-ruby/models/app_store/subscription.rb, line 73 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::AppStore::Subscription` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::AppStore::Subscription`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'current_period_end') self.current_period_end = attributes[:'current_period_end'] end if attributes.key?(:'end_date') self.end_date = attributes[:'end_date'] end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'organisation_id') self.organisation_id = attributes[:'organisation_id'] end if attributes.key?(:'plans') if (value = attributes[:'plans']).is_a?(Array) self.plans = value end end if attributes.key?(:'start_date') self.start_date = attributes[:'start_date'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'test_mode') self.test_mode = attributes[:'test_mode'] end end
Attribute type mapping.
# File lib/xero-ruby/models/app_store/subscription.rb, line 58 def self.openapi_types { :'current_period_end' => :'DateTime', :'end_date' => :'DateTime', :'id' => :'String', :'organisation_id' => :'String', :'plans' => :'Array<Plan>', :'start_date' => :'DateTime', :'status' => :'String', :'test_mode' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/xero-ruby/models/app_store/subscription.rb, line 166 def ==(o) return true if self.equal?(o) self.class == o.class && current_period_end == o.current_period_end && end_date == o.end_date && id == o.id && organisation_id == o.organisation_id && plans == o.plans && start_date == o.start_date && status == o.status && test_mode == o.test_mode 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/xero-ruby/models/app_store/subscription.rb, line 222 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(parse_date(value)) when :Date Date.parse(parse_date(value)) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BigDecimal BigDecimal(value.to_s) 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 XeroRuby::AppStore.const_get(type).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/xero-ruby/models/app_store/subscription.rb, line 295 def _to_hash(value, downcase: false) if value.is_a?(Array) value.map do |v| v.to_hash(downcase: downcase) end elsif value.is_a?(Hash) {}.tap do |hash| value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) } end elsif value.respond_to? :to_hash value.to_hash(downcase: downcase) 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/xero-ruby/models/app_store/subscription.rb, line 201 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that 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/xero-ruby/models/app_store/subscription.rb, line 181 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/xero-ruby/models/app_store/subscription.rb, line 187 def hash [current_period_end, end_date, id, organisation_id, plans, start_date, status, test_mode].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/xero-ruby/models/app_store/subscription.rb, line 123 def list_invalid_properties invalid_properties = Array.new if @current_period_end.nil? invalid_properties.push('invalid value for "current_period_end", current_period_end cannot be nil.') end if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @organisation_id.nil? invalid_properties.push('invalid value for "organisation_id", organisation_id cannot be nil.') end if @plans.nil? invalid_properties.push('invalid value for "plans", plans cannot be nil.') end if @start_date.nil? invalid_properties.push('invalid value for "start_date", start_date cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end invalid_properties end
# File lib/xero-ruby/models/app_store/subscription.rb, line 311 def parse_date(datestring) if datestring.include?('Date') date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\// original, date, timezone = *date_pattern.match(datestring) date = (date.to_i / 1000) Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s else # handle date 'types' for small subset of payroll API's Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s end end
Returns the object in the form of hash with snake_case
# File lib/xero-ruby/models/app_store/subscription.rb, line 287 def to_attributes to_hash(downcase: true) end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/xero-ruby/models/app_store/subscription.rb, line 275 def to_hash(downcase: false) hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? key = downcase ? attr : param hash[key] = _to_hash(value, downcase: downcase) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/xero-ruby/models/app_store/subscription.rb, line 263 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/xero-ruby/models/app_store/subscription.rb, line 154 def valid? return false if @current_period_end.nil? return false if @id.nil? return false if @organisation_id.nil? return false if @plans.nil? return false if @start_date.nil? return false if @status.nil? true end