class VoucherifySdk::CampaignsVouchersCreateRequestBody
Request body schema for POST ‘v1/campaigns/{campaignId}/vouchers/{code}`.
Attributes
An optional field to keep any extra textual information about the code such as a code description and details.
The category assigned to the campaign. Either pass this parameter OR the ‘category_id`.
Expiration timestamp defines when the voucher expires in ISO 8601 format. Voucher
is *inactive after* this date.
The metadata object stores all custom attributes assigned to the voucher. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
Activation timestamp defines when the voucher starts to be active in ISO 8601 format. Voucher
is *inactive before* this date.
Public Class Methods
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 177 def self._deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = VoucherifySdk.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Returns all the JSON keys this model knows about
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 49 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 37 def self.attribute_map { :'category' => :'category', :'metadata' => :'metadata', :'redemption' => :'redemption', :'additional_info' => :'additional_info', :'start_date' => :'start_date', :'expiration_date' => :'expiration_date' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 153 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif 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[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 79 def initialize(attributes = {}) # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.key?(:'category') self.category = attributes[:'category'] end if attributes.key?(:'metadata') self.metadata = attributes[:'metadata'] end if attributes.key?(:'redemption') self.redemption = attributes[:'redemption'] end if attributes.key?(:'additional_info') self.additional_info = attributes[:'additional_info'] end if attributes.key?(:'start_date') self.start_date = attributes[:'start_date'] end if attributes.key?(:'expiration_date') self.expiration_date = attributes[:'expiration_date'] end end
List of attributes with nullable: true
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 66 def self.openapi_nullable Set.new([ :'category', :'metadata', :'redemption', :'additional_info', :'start_date', :'expiration_date' ]) end
Attribute type mapping.
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 54 def self.openapi_types { :'category' => :'String', :'metadata' => :'Object', :'redemption' => :'CampaignsVouchersCreateRequestBodyRedemption', :'additional_info' => :'String', :'start_date' => :'Time', :'expiration_date' => :'Time' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 127 def ==(o) return true if self.equal?(o) self.class == o.class && category == o.category && metadata == o.metadata && redemption == o.redemption && additional_info == o.additional_info && start_date == o.start_date && expiration_date == o.expiration_date 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/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 248 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 140 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 146 def hash [category, metadata, redemption, additional_info, start_date, expiration_date].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 112 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 230 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 218 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/VoucherifySdk/models/campaigns_vouchers_create_request_body.rb, line 120 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end