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



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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 143

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#content ⇒ Object

Actual template contents



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

def content
  @content
end

#esp_domain_uuid ⇒ Object

The uuid of the sending domain



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

def esp_domain_uuid
  @esp_domain_uuid
end

#esp_friendly_name ⇒ Object

Friendly from that will appear in customer email clients.



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

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.



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

def esp_user
  @esp_user
end

#file_exists ⇒ Object

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



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

def file_exists
  @file_exists
end

#file_name ⇒ Object

File name



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

def file_name
  @file_name
end

#group ⇒ Object

Group



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

def group
  @group
end

#handlebar_variables ⇒ Object

Handlebar Variables available for email template



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

def handlebar_variables
  @handlebar_variables
end

#invalid ⇒ Object

Invalid will be true if the template cannot compile



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

def invalid
  @invalid
end

#last_modified ⇒ Object

Last modified timestamp



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

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.



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

def library_item_oid
  @library_item_oid
end

#options ⇒ Object

Options that help govern how and when this template is used



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

def options
  @options
end

#path ⇒ Object

directory path where template is stored in file system



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

def path
  @path
end

#size ⇒ Object

Size of file in friendly description



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

def size
  @size
end

#store_front_fs_directory_oid ⇒ Object

Internal identifier used to store and retrieve template from filesystem



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

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



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

def store_front_fs_file_oid
  @store_front_fs_file_oid
end

#subject ⇒ Object

Subject



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

def subject
  @subject
end

#syntax_errors ⇒ Object

Any syntax errors contained within the tempalate



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

def syntax_errors
  @syntax_errors
end

#template_path_relative_path ⇒ Object

Internal value used to locate the template in the filesystem



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

def template_path_relative_path
  @template_path_relative_path
end

#theme_relative_path ⇒ Object

Theme relative path in the filesystem.



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

def theme_relative_path
  @theme_relative_path
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



105
106
107
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 105

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.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



296
297
298
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 296

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



136
137
138
139
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 136

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

.openapi_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 110

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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 256

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



327
328
329
330
331
332
333
334
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
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 327

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



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 398

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 303

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


283
284
285
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

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



243
244
245
246
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 243

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



374
375
376
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 374

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



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 380

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



368
369
370
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 368

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



250
251
252
 
# File 'lib/ultracart_api/models/transaction_email.rb', line 250

def valid?
  true
end