Class: TalonOne::NewCampaignTemplate
- Inherits:
-
Object
- Object
- TalonOne::NewCampaignTemplate
- Defined in:
- lib/talon_one/models/new_campaign_template.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#campaign_attributes ⇒ Object
The campaign attributes that campaigns created from this template will have by default.
-
#campaign_collections ⇒ Object
The campaign collections from the blueprint campaign for the template.
-
#coupon_attributes ⇒ Object
The campaign attributes that coupons created from this template will have by default.
-
#coupon_settings ⇒ Object
Returns the value of attribute coupon_settings.
-
#default_campaign_group_id ⇒ Object
The default campaign group ID.
-
#description ⇒ Object
Customer-facing text that explains the objective of the template.
-
#features ⇒ Object
A list of features for the campaign template.
-
#instructions ⇒ Object
Customer-facing text that explains how to use the template.
-
#limits ⇒ Object
The set of limits that will operate for this campaign template.
-
#name ⇒ Object
The campaign template name.
-
#referral_settings ⇒ Object
Returns the value of attribute referral_settings.
-
#state ⇒ Object
Only Campaign Templates in ‘available’ state may be used to create Campaigns.
-
#tags ⇒ Object
A list of tags for the campaign template.
-
#template_params ⇒ Object
Fields which can be used to replace values in a rule.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ NewCampaignTemplate
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ NewCampaignTemplate
Initializes the object
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 127 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::NewCampaignTemplate` 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 `TalonOne::NewCampaignTemplate`. 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?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'instructions') self.instructions = attributes[:'instructions'] end if attributes.key?(:'campaign_attributes') self.campaign_attributes = attributes[:'campaign_attributes'] end if attributes.key?(:'coupon_attributes') self.coupon_attributes = attributes[:'coupon_attributes'] end if attributes.key?(:'state') self.state = attributes[:'state'] end if attributes.key?(:'tags') if (value = attributes[:'tags']).is_a?(Array) self. = value end end if attributes.key?(:'features') if (value = attributes[:'features']).is_a?(Array) self.features = value end end if attributes.key?(:'coupon_settings') self.coupon_settings = attributes[:'coupon_settings'] end if attributes.key?(:'referral_settings') self.referral_settings = attributes[:'referral_settings'] end if attributes.key?(:'limits') if (value = attributes[:'limits']).is_a?(Array) self.limits = value end end if attributes.key?(:'template_params') if (value = attributes[:'template_params']).is_a?(Array) self.template_params = value end end if attributes.key?(:'campaign_collections') if (value = attributes[:'campaign_collections']).is_a?(Array) self.campaign_collections = value end end if attributes.key?(:'default_campaign_group_id') self.default_campaign_group_id = attributes[:'default_campaign_group_id'] end end |
Instance Attribute Details
#campaign_attributes ⇒ Object
The campaign attributes that campaigns created from this template will have by default.
27 28 29 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 27 def campaign_attributes @campaign_attributes end |
#campaign_collections ⇒ Object
The campaign collections from the blueprint campaign for the template.
52 53 54 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 52 def campaign_collections @campaign_collections end |
#coupon_attributes ⇒ Object
The campaign attributes that coupons created from this template will have by default.
30 31 32 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 30 def coupon_attributes @coupon_attributes end |
#coupon_settings ⇒ Object
Returns the value of attribute coupon_settings.
41 42 43 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 41 def coupon_settings @coupon_settings end |
#default_campaign_group_id ⇒ Object
The default campaign group ID.
55 56 57 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 55 def default_campaign_group_id @default_campaign_group_id end |
#description ⇒ Object
Customer-facing text that explains the objective of the template.
21 22 23 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 21 def description @description end |
#features ⇒ Object
A list of features for the campaign template.
39 40 41 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 39 def features @features end |
#instructions ⇒ Object
Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign.
24 25 26 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 24 def instructions @instructions end |
#limits ⇒ Object
The set of limits that will operate for this campaign template.
46 47 48 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 46 def limits @limits end |
#name ⇒ Object
The campaign template name.
18 19 20 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 18 def name @name end |
#referral_settings ⇒ Object
Returns the value of attribute referral_settings.
43 44 45 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 43 def referral_settings @referral_settings end |
#state ⇒ Object
Only Campaign Templates in ‘available’ state may be used to create Campaigns.
33 34 35 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 33 def state @state end |
#tags ⇒ Object
A list of tags for the campaign template.
36 37 38 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 36 def @tags end |
#template_params ⇒ Object
Fields which can be used to replace values in a rule.
49 50 51 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 49 def template_params @template_params end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 80 def self.attribute_map { :'name' => :'name', :'description' => :'description', :'instructions' => :'instructions', :'campaign_attributes' => :'campaignAttributes', :'coupon_attributes' => :'couponAttributes', :'state' => :'state', :'tags' => :'tags', :'features' => :'features', :'coupon_settings' => :'couponSettings', :'referral_settings' => :'referralSettings', :'limits' => :'limits', :'template_params' => :'templateParams', :'campaign_collections' => :'campaignCollections', :'default_campaign_group_id' => :'defaultCampaignGroupId' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
307 308 309 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 307 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
120 121 122 123 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 120 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 100 def self.openapi_types { :'name' => :'String', :'description' => :'String', :'instructions' => :'String', :'campaign_attributes' => :'Object', :'coupon_attributes' => :'Object', :'state' => :'String', :'tags' => :'Array<String>', :'features' => :'Array<String>', :'coupon_settings' => :'CodeGeneratorSettings', :'referral_settings' => :'CodeGeneratorSettings', :'limits' => :'Array<TemplateLimitConfig>', :'template_params' => :'Array<CampaignTemplateParams>', :'campaign_collections' => :'Array<CampaignTemplateCollection>', :'default_campaign_group_id' => :'Integer' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 273 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && description == o.description && instructions == o.instructions && campaign_attributes == o.campaign_attributes && coupon_attributes == o.coupon_attributes && state == o.state && == o. && features == o.features && coupon_settings == o.coupon_settings && referral_settings == o.referral_settings && limits == o.limits && template_params == o.template_params && campaign_collections == o.campaign_collections && default_campaign_group_id == o.default_campaign_group_id end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 335 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 TalonOne.const_get(type).build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
404 405 406 407 408 409 410 411 412 413 414 415 416 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 404 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 314 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 |
#eql?(o) ⇒ Boolean
294 295 296 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 294 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
300 301 302 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 300 def hash [name, description, instructions, campaign_attributes, coupon_attributes, state, , features, coupon_settings, referral_settings, limits, template_params, campaign_collections, default_campaign_group_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 209 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @name.to_s.length < 1 invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.') end if @description.nil? invalid_properties.push('invalid value for "description", description cannot be nil.') end if @instructions.nil? invalid_properties.push('invalid value for "instructions", instructions cannot be nil.') end if @state.nil? invalid_properties.push('invalid value for "state", state cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
380 381 382 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 380 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
386 387 388 389 390 391 392 393 394 395 396 397 398 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 386 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 |
#to_s ⇒ String
Returns the string representation of the object
374 375 376 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 374 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
236 237 238 239 240 241 242 243 244 245 |
# File 'lib/talon_one/models/new_campaign_template.rb', line 236 def valid? return false if @name.nil? return false if @name.to_s.length < 1 return false if @description.nil? return false if @instructions.nil? return false if @state.nil? state_validator = EnumAttributeValidator.new('String', ["draft", "enabled", "disabled"]) return false unless state_validator.valid?(@state) true end |