class Bfwd::CancelSubscriptionRequest
Attributes
Specifies whether the service will end immediately on cancellation or if it will continue until the end of the current period. Default: AtPeriodEnd
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/cancel_subscription_request.rb, line 56 def self.attribute_map { :'subscription_id' => :'subscriptionID', :'state' => :'state', :'source' => :'source', :'service_end' => :'serviceEnd', :'cancellation_credit' => :'cancellationCredit', :'cancel_children' => :'cancelChildren', :'cancel_empty_parent' => :'cancelEmptyParent' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/cancel_subscription_request.rb, line 83 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?(:'subscriptionID') self.subscription_id = attributes[:'subscriptionID'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'source') self.source = attributes[:'source'] end if attributes.has_key?(:'serviceEnd') self.service_end = attributes[:'serviceEnd'] end if attributes.has_key?(:'cancellationCredit') self.cancellation_credit = attributes[:'cancellationCredit'] end if attributes.has_key?(:'cancelChildren') self.cancel_children = attributes[:'cancelChildren'] end if attributes.has_key?(:'cancelEmptyParent') self.cancel_empty_parent = attributes[:'cancelEmptyParent'] end end
Attribute type mapping.
# File lib/bf_ruby2/models/cancel_subscription_request.rb, line 69 def self.swagger_types { :'subscription_id' => :'String', :'state' => :'String', :'source' => :'String', :'service_end' => :'String', :'cancellation_credit' => :'String', :'cancel_children' => :'BOOLEAN', :'cancel_empty_parent' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/cancel_subscription_request.rb, line 168 def ==(o) return true if self.equal?(o) self.class == o.class && subscription_id == o.subscription_id && state == o.state && source == o.source && service_end == o.service_end && cancellation_credit == o.cancellation_credit && cancel_children == o.cancel_children && cancel_empty_parent == o.cancel_empty_parent 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/cancel_subscription_request.rb, line 216 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/cancel_subscription_request.rb, line 282 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/cancel_subscription_request.rb, line 195 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
Custom attribute writer method checking allowed values (enum). @param [Object] cancellation_credit
Object to be assigned
# File lib/bf_ruby2/models/cancel_subscription_request.rb, line 158 def cancellation_credit=(cancellation_credit) validator = EnumAttributeValidator.new('String', ["Credit", "None"]) unless validator.valid?(cancellation_credit) fail ArgumentError, "invalid value for 'cancellation_credit', must be one of #{validator.allowable_values}." end @cancellation_credit = cancellation_credit end
@see the `==` method @param [Object] Object to be compared
# File lib/bf_ruby2/models/cancel_subscription_request.rb, line 182 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/cancel_subscription_request.rb, line 188 def hash [subscription_id, state, source, service_end, cancellation_credit, cancel_children, cancel_empty_parent].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/cancel_subscription_request.rb, line 121 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 @source.nil? invalid_properties.push("invalid value for 'source', source cannot be nil.") end return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] service_end
Object to be assigned
# File lib/bf_ruby2/models/cancel_subscription_request.rb, line 148 def service_end=(service_end) validator = EnumAttributeValidator.new('String', ["Immediate", "AtPeriodEnd"]) unless validator.valid?(service_end) fail ArgumentError, "invalid value for 'service_end', must be one of #{validator.allowable_values}." end @service_end = service_end end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/bf_ruby2/models/cancel_subscription_request.rb, line 268 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/cancel_subscription_request.rb, line 256 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/cancel_subscription_request.rb, line 136 def valid? return false if @subscription_id.nil? return false if @source.nil? service_end_validator = EnumAttributeValidator.new('String', ["Immediate", "AtPeriodEnd"]) return false unless service_end_validator.valid?(@service_end) cancellation_credit_validator = EnumAttributeValidator.new('String', ["Credit", "None"]) return false unless cancellation_credit_validator.valid?(@cancellation_credit) return true end