Class: UltracartClient::TransactionEmail

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionEmail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 131

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

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

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

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

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

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

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

  if attributes.has_key?(:'handlebar_variables')
    if (value = attributes[:'handlebar_variables']).is_a?(Array)
      self.handlebar_variables = value
    end
  end

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

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

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

  if attributes.has_key?(:'options')
    if (value = attributes[:'options']).is_a?(Array)
      self.options = value
    end
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#content ⇒ Object

Actual template contents



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

def content
  @content
end

#esp_domain_uuid ⇒ Object

The uuid of the sending domain



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

def esp_domain_uuid
  @esp_domain_uuid
end

#esp_friendly_name ⇒ Object

Friendly from that will appear in customer email clients.



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

def esp_friendly_name
  @esp_friendly_name
end

#esp_user ⇒ Object

The username of the sending email. This is not the full email. Only the username which is everything before the @ sign.



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

def esp_user
  @esp_user
end

#file_exists ⇒ Object

An internal identifier used to aid in retrieving templates from the filesystem.



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

def file_exists
  @file_exists
end

#file_name ⇒ Object

File name



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

def file_name
  @file_name
end

#group ⇒ Object

Group



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

def group
  @group
end

#handlebar_variables ⇒ Object

Handlebar Variables available for email template



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

def handlebar_variables
  @handlebar_variables
end

#invalid ⇒ Object

Invalid will be true if the template cannot compile



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

def invalid
  @invalid
end

#last_modified ⇒ Object

Last modified timestamp



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

def last_modified
  @last_modified
end

#library_item_oid ⇒ Object

If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.



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

def library_item_oid
  @library_item_oid
end

#options ⇒ Object

Options that help govern how and when this template is used



51
52
53
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 51

def options
  @options
end

#path ⇒ Object

directory path where template is stored in file system



54
55
56
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 54

def path
  @path
end

#size ⇒ Object

Size of file in friendly description



57
58
59
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 57

def size
  @size
end

#store_front_fs_directory_oid ⇒ Object

Internal identifier used to store and retrieve template from filesystem



60
61
62
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 60

def store_front_fs_directory_oid
  @store_front_fs_directory_oid
end

#store_front_fs_file_oid ⇒ Object

Internal identifier used to store and retrieve template from filesystem



63
64
65
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 63

def store_front_fs_file_oid
  @store_front_fs_file_oid
end

#subject ⇒ Object

Subject



66
67
68
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 66

def subject
  @subject
end

#syntax_errors ⇒ Object

Any syntax errors contained within the tempalate



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

def syntax_errors
  @syntax_errors
end

#template_path_relative_path ⇒ Object

Internal value used to locate the template in the filesystem



72
73
74
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 72

def template_path_relative_path
  @template_path_relative_path
end

#theme_relative_path ⇒ Object

Theme relative path in the filesystem.



75
76
77
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 75

def theme_relative_path
  @theme_relative_path
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 78

def self.attribute_map
  {
    :'content' => :'content',
    :'esp_domain_uuid' => :'esp_domain_uuid',
    :'esp_friendly_name' => :'esp_friendly_name',
    :'esp_user' => :'esp_user',
    :'file_exists' => :'file_exists',
    :'file_name' => :'file_name',
    :'group' => :'group',
    :'handlebar_variables' => :'handlebar_variables',
    :'invalid' => :'invalid',
    :'last_modified' => :'last_modified',
    :'library_item_oid' => :'library_item_oid',
    :'options' => :'options',
    :'path' => :'path',
    :'size' => :'size',
    :'store_front_fs_directory_oid' => :'store_front_fs_directory_oid',
    :'store_front_fs_file_oid' => :'store_front_fs_file_oid',
    :'subject' => :'subject',
    :'syntax_errors' => :'syntax_errors',
    :'template_path_relative_path' => :'template_path_relative_path',
    :'theme_relative_path' => :'theme_relative_path'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 104

def self.swagger_types
  {
    :'content' => :'String',
    :'esp_domain_uuid' => :'String',
    :'esp_friendly_name' => :'String',
    :'esp_user' => :'String',
    :'file_exists' => :'BOOLEAN',
    :'file_name' => :'String',
    :'group' => :'String',
    :'handlebar_variables' => :'Array<String>',
    :'invalid' => :'BOOLEAN',
    :'last_modified' => :'String',
    :'library_item_oid' => :'Integer',
    :'options' => :'Array<TransactionEmailOption>',
    :'path' => :'String',
    :'size' => :'String',
    :'store_front_fs_directory_oid' => :'Integer',
    :'store_front_fs_file_oid' => :'Integer',
    :'subject' => :'String',
    :'syntax_errors' => :'String',
    :'template_path_relative_path' => :'String',
    :'theme_relative_path' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 237

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content == o.content &&
      esp_domain_uuid == o.esp_domain_uuid &&
      esp_friendly_name == o.esp_friendly_name &&
      esp_user == o.esp_user &&
      file_exists == o.file_exists &&
      file_name == o.file_name &&
      group == o.group &&
      handlebar_variables == o.handlebar_variables &&
      invalid == o.invalid &&
      last_modified == o.last_modified &&
      library_item_oid == o.library_item_oid &&
      options == o.options &&
      path == o.path &&
      size == o.size &&
      store_front_fs_directory_oid == o.store_front_fs_directory_oid &&
      store_front_fs_file_oid == o.store_front_fs_file_oid &&
      subject == o.subject &&
      syntax_errors == o.syntax_errors &&
      template_path_relative_path == o.template_path_relative_path &&
      theme_relative_path == o.theme_relative_path
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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 298

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 364

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 277

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


264
265
266
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



270
271
272
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 270

def hash
  [content, esp_domain_uuid, esp_friendly_name, esp_user, file_exists, file_name, group, handlebar_variables, invalid, last_modified, library_item_oid, options, path, size, store_front_fs_directory_oid, store_front_fs_file_oid, subject, syntax_errors, template_path_relative_path, theme_relative_path].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



224
225
226
227
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 224

def list_invalid_properties
  invalid_properties = Array.new
  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



344
345
346
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 344

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



350
351
352
353
354
355
356
357
358
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 350

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



338
339
340
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 338

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



231
232
233
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 231

def valid?
  true
end