class Bfwd::AddCouponCodeRequest
<p> Request object containing the coupon code to be applied to the subscription.There are two choices when specifying the above mentioned code: </p>Unique Code - When specifying an existing unique code, the coupon associated to that code will be applied to the subscription, if it is still available.Master Code - When specifying the base code of the coupon, an attempt will be made to generate an unique code if there is still availability to do so.
Attributes
{ "description" : "ID of the user who last updated the entity.", "verbs":[] }
{ "description" : "The couponCode can be either a unique code or the master code of a coupon.", "verbs":["POST"]}
{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }
{ "description" : "", "verbs":["POST"]}
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/bf_ruby2/models/add_coupon_code_request.rb, line 32 def self.attribute_map { :'created' => :'created', :'changed_by' => :'changedBy', :'organization_id' => :'organizationID', :'coupon_code' => :'couponCode' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/bf_ruby2/models/add_coupon_code_request.rb, line 53 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?(:'changedBy') self.changed_by = attributes[:'changedBy'] end if attributes.has_key?(:'organizationID') self.organization_id = attributes[:'organizationID'] end if attributes.has_key?(:'couponCode') self.coupon_code = attributes[:'couponCode'] end end
Attribute type mapping.
# File lib/bf_ruby2/models/add_coupon_code_request.rb, line 42 def self.swagger_types { :'created' => :'DateTime', :'changed_by' => :'String', :'organization_id' => :'String', :'coupon_code' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/bf_ruby2/models/add_coupon_code_request.rb, line 97 def ==(o) return true if self.equal?(o) self.class == o.class && created == o.created && changed_by == o.changed_by && organization_id == o.organization_id && coupon_code == o.coupon_code 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/add_coupon_code_request.rb, line 142 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/add_coupon_code_request.rb, line 208 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/add_coupon_code_request.rb, line 121 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/add_coupon_code_request.rb, line 108 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/bf_ruby2/models/add_coupon_code_request.rb, line 114 def hash [created, changed_by, organization_id, coupon_code].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/add_coupon_code_request.rb, line 79 def list_invalid_properties invalid_properties = Array.new if @coupon_code.nil? invalid_properties.push("invalid value for 'coupon_code', coupon_code 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/add_coupon_code_request.rb, line 194 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/add_coupon_code_request.rb, line 182 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/add_coupon_code_request.rb, line 90 def valid? return false if @coupon_code.nil? return true end