Class: UltracartClient::EmailTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/email_template.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailTemplate

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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
 
# File 'lib/ultracart_api/models/email_template.rb', line 98

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::EmailTemplate` 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 `UltracartClient::EmailTemplate`. 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?(:'container_cjson')
    self.container_cjson = attributes[:'container_cjson']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'email_template_oid')
    self.email_template_oid = attributes[:'email_template_oid']
  end

  if attributes.key?(:'email_template_vm_path')
    self.email_template_vm_path = attributes[:'email_template_vm_path']
  end

  if attributes.key?(:'merchant_id')
    self.merchant_id = attributes[:'merchant_id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'preview_amazon_listing_key')
    self.preview_amazon_listing_key = attributes[:'preview_amazon_listing_key']
  end

  if attributes.key?(:'sort_order')
    self.sort_order = attributes[:'sort_order']
  end

  if attributes.key?(:'storefront_oid')
    self.storefront_oid = attributes[:'storefront_oid']
  end

  if attributes.key?(:'system')
    self.system = attributes[:'system']
  end

  if attributes.key?(:'trigger_type')
    self.trigger_type = attributes[:'trigger_type']
  end
end

Instance Attribute Details

#container_cjson ⇒ Object

Container cjson



19
20
21
 
# File 'lib/ultracart_api/models/email_template.rb', line 19

def container_cjson
  @container_cjson
end

#description ⇒ Object

Description of email template



22
23
24
 
# File 'lib/ultracart_api/models/email_template.rb', line 22

def description
  @description
end

#email_template_oid ⇒ Object

Email template oid



25
26
27
 
# File 'lib/ultracart_api/models/email_template.rb', line 25

def email_template_oid
  @email_template_oid
end

#email_template_vm_path ⇒ Object

Email Template VM Path



28
29
30
 
# File 'lib/ultracart_api/models/email_template.rb', line 28

def email_template_vm_path
  @email_template_vm_path
end

#merchant_id ⇒ Object

Merchant ID



31
32
33
 
# File 'lib/ultracart_api/models/email_template.rb', line 31

def merchant_id
  @merchant_id
end

#name ⇒ Object

Name of email template



34
35
36
 
# File 'lib/ultracart_api/models/email_template.rb', line 34

def name
  @name
end

#preview_amazon_listing_key ⇒ Object

Amazon key for preview png image



37
38
39
 
# File 'lib/ultracart_api/models/email_template.rb', line 37

def preview_amazon_listing_key
  @preview_amazon_listing_key
end

#sort_order ⇒ Object

Sort order (optional)



40
41
42
 
# File 'lib/ultracart_api/models/email_template.rb', line 40

def sort_order
  @sort_order
end

#storefront_oid ⇒ Object

StoreFront oid



43
44
45
 
# File 'lib/ultracart_api/models/email_template.rb', line 43

def storefront_oid
  @storefront_oid
end

#system ⇒ Object

True if this email template is system-wide,false if merchant specific



46
47
48
 
# File 'lib/ultracart_api/models/email_template.rb', line 46

def system
  @system
end

#trigger_type ⇒ Object

Trigger type



49
50
51
 
# File 'lib/ultracart_api/models/email_template.rb', line 49

def trigger_type
  @trigger_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/ultracart_api/models/email_template.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/ultracart_api/models/email_template.rb', line 52

def self.attribute_map
  {
    :'container_cjson' => :'container_cjson',
    :'description' => :'description',
    :'email_template_oid' => :'email_template_oid',
    :'email_template_vm_path' => :'email_template_vm_path',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'preview_amazon_listing_key' => :'preview_amazon_listing_key',
    :'sort_order' => :'sort_order',
    :'storefront_oid' => :'storefront_oid',
    :'system' => :'system',
    :'trigger_type' => :'trigger_type'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



247
248
249
 
# File 'lib/ultracart_api/models/email_template.rb', line 247

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/ultracart_api/models/email_template.rb', line 91

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ultracart_api/models/email_template.rb', line 74

def self.openapi_types
  {
    :'container_cjson' => :'String',
    :'description' => :'String',
    :'email_template_oid' => :'Integer',
    :'email_template_vm_path' => :'String',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'preview_amazon_listing_key' => :'String',
    :'sort_order' => :'Integer',
    :'storefront_oid' => :'Integer',
    :'system' => :'Boolean',
    :'trigger_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/ultracart_api/models/email_template.rb', line 216

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      container_cjson == o.container_cjson &&
      description == o.description &&
      email_template_oid == o.email_template_oid &&
      email_template_vm_path == o.email_template_vm_path &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      preview_amazon_listing_key == o.preview_amazon_listing_key &&
      sort_order == o.sort_order &&
      storefront_oid == o.storefront_oid &&
      system == o.system &&
      trigger_type == o.trigger_type
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/ultracart_api/models/email_template.rb', line 278

def _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 = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/ultracart_api/models/email_template.rb', line 349

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ultracart_api/models/email_template.rb', line 254

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


234
235
236
 
# File 'lib/ultracart_api/models/email_template.rb', line 234

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



240
241
242
 
# File 'lib/ultracart_api/models/email_template.rb', line 240

def hash
  [container_cjson, description, email_template_oid, email_template_vm_path, merchant_id, name, preview_amazon_listing_key, sort_order, storefront_oid, system, trigger_type].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/ultracart_api/models/email_template.rb', line 158

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 250
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 250.')
  end

  if !@preview_amazon_listing_key.nil? && @preview_amazon_listing_key.to_s.length > 250
    invalid_properties.push('invalid value for "preview_amazon_listing_key", the character length must be smaller than or equal to 250.')
  end

  if !@trigger_type.nil? && @trigger_type.to_s.length > 100
    invalid_properties.push('invalid value for "trigger_type", the character length must be smaller than or equal to 100.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



325
326
327
 
# File 'lib/ultracart_api/models/email_template.rb', line 325

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/ultracart_api/models/email_template.rb', line 331

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

Returns:

  • (String) —

    String presentation of the object



319
320
321
 
# File 'lib/ultracart_api/models/email_template.rb', line 319

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



177
178
179
180
181
182
 
# File 'lib/ultracart_api/models/email_template.rb', line 177

def valid?
  return false if !@name.nil? && @name.to_s.length > 250
  return false if !@preview_amazon_listing_key.nil? && @preview_amazon_listing_key.to_s.length > 250
  return false if !@trigger_type.nil? && @trigger_type.to_s.length > 100
  true
end