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



86
87
88
89
90
91
92
93
94
95
96
97
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
 
# File 'lib/ultracart_api/models/email_template.rb', line 86

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?(:'container_cjson')
    self.container_cjson = attributes[:'container_cjson']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#container_cjson ⇒ Object

Container cjson



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

def container_cjson
  @container_cjson
end

#description ⇒ Object

Description of email template



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

def description
  @description
end

#email_template_oid ⇒ Object

Email template oid



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

def email_template_oid
  @email_template_oid
end

#email_template_vm_path ⇒ Object

Email Template VM Path



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

def email_template_vm_path
  @email_template_vm_path
end

#merchant_id ⇒ Object

Merchant ID



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

def merchant_id
  @merchant_id
end

#name ⇒ Object

Name of email template



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

def name
  @name
end

#preview_amazon_listing_key ⇒ Object

Amazon key for preview png image



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

def preview_amazon_listing_key
  @preview_amazon_listing_key
end

#sort_order ⇒ Object

Sort order (optional)



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

def sort_order
  @sort_order
end

#storefront_oid ⇒ Object

StoreFront oid



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

def storefront_oid
  @storefront_oid
end

#system ⇒ Object

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



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

def system
  @system
end

#trigger_type ⇒ Object

Trigger type



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

def trigger_type
  @trigger_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/ultracart_api/models/email_template.rb', line 68

def self.swagger_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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/ultracart_api/models/email_template.rb', line 197

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/ultracart_api/models/email_template.rb', line 249

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 = UltracartClient.const_get(type).new
    temp_model.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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/ultracart_api/models/email_template.rb', line 315

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/ultracart_api/models/email_template.rb', line 228

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 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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


215
216
217
 
# File 'lib/ultracart_api/models/email_template.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



221
222
223
 
# File 'lib/ultracart_api/models/email_template.rb', line 221

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



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 139

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



295
296
297
 
# File 'lib/ultracart_api/models/email_template.rb', line 295

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



301
302
303
304
305
306
307
308
309
 
# File 'lib/ultracart_api/models/email_template.rb', line 301

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



289
290
291
 
# File 'lib/ultracart_api/models/email_template.rb', line 289

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



158
159
160
161
162
163
 
# File 'lib/ultracart_api/models/email_template.rb', line 158

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