class VoucherifySdk::TemplatesCampaignsCreateRequestBody
Request body schema for POST ‘/templates/campaign`.
Attributes
Unique identifier of the campaign that will create a template. It must be an ID of an existing discount or gift card campaign. It cannot be passed when ‘promotion_tier_id` has value. Required when the `promotion_tier_id` is not passed or it is `null`.
User-defined description of the campaign template.
User-defined name of the campaign template. It must be unique.
Unique identifier of the promotion tier that will create a template. It cannot be passed when ‘campaign_id` has value. Required when the `campaign_id` is not passed or it is `null`.
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/templates_campaigns_create_request_body.rb, line 156 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/templates_campaigns_create_request_body.rb, line 42 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/VoucherifySdk/models/templates_campaigns_create_request_body.rb, line 32 def self.attribute_map { :'campaign_id' => :'campaign_id', :'promotion_tier_id' => :'promotion_tier_id', :'name' => :'name', :'description' => :'description' } 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/templates_campaigns_create_request_body.rb, line 132 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/templates_campaigns_create_request_body.rb, line 68 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?(:'campaign_id') self.campaign_id = attributes[:'campaign_id'] end if attributes.key?(:'promotion_tier_id') self.promotion_tier_id = attributes[:'promotion_tier_id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'description') self.description = attributes[:'description'] end end
List of attributes with nullable: true
# File lib/VoucherifySdk/models/templates_campaigns_create_request_body.rb, line 57 def self.openapi_nullable Set.new([ :'campaign_id', :'promotion_tier_id', :'name', :'description' ]) end
Attribute type mapping.
# File lib/VoucherifySdk/models/templates_campaigns_create_request_body.rb, line 47 def self.openapi_types { :'campaign_id' => :'String', :'promotion_tier_id' => :'String', :'name' => :'String', :'description' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/VoucherifySdk/models/templates_campaigns_create_request_body.rb, line 108 def ==(o) return true if self.equal?(o) self.class == o.class && campaign_id == o.campaign_id && promotion_tier_id == o.promotion_tier_id && name == o.name && description == o.description 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/templates_campaigns_create_request_body.rb, line 227 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/templates_campaigns_create_request_body.rb, line 119 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/VoucherifySdk/models/templates_campaigns_create_request_body.rb, line 125 def hash [campaign_id, promotion_tier_id, name, description].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/templates_campaigns_create_request_body.rb, line 93 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/templates_campaigns_create_request_body.rb, line 209 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/templates_campaigns_create_request_body.rb, line 197 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/templates_campaigns_create_request_body.rb, line 101 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end