Class: UltracartClient::EmailSettings

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/ultracart_api/models/email_settings.rb', line 124

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#emails_per_day ⇒ Object

Emails per day allowed



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

def emails_per_day
  @emails_per_day
end

#emails_per_hour ⇒ Object

Emails per hour allowed



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

def emails_per_hour
  @emails_per_hour
end

#emails_per_month ⇒ Object

Emails per month allowed



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

def emails_per_month
  @emails_per_month
end

#marketing_esp_domain_user ⇒ Object

Returns the value of attribute marketing_esp_domain_user.



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

def marketing_esp_domain_user
  @marketing_esp_domain_user
end

#marketing_esp_domain_uuid ⇒ Object

Returns the value of attribute marketing_esp_domain_uuid.



29
30
31
 
# File 'lib/ultracart_api/models/email_settings.rb', line 29

def marketing_esp_domain_uuid
  @marketing_esp_domain_uuid
end

#marketing_esp_friendly_name ⇒ Object

Returns the value of attribute marketing_esp_friendly_name.



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

def marketing_esp_friendly_name
  @marketing_esp_friendly_name
end

#postcard_from_address1 ⇒ Object

Returns the value of attribute postcard_from_address1.



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

def postcard_from_address1
  @postcard_from_address1
end

#postcard_from_address2 ⇒ Object

Returns the value of attribute postcard_from_address2.



35
36
37
 
# File 'lib/ultracart_api/models/email_settings.rb', line 35

def postcard_from_address2
  @postcard_from_address2
end

#postcard_from_city ⇒ Object

Returns the value of attribute postcard_from_city.



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

def postcard_from_city
  @postcard_from_city
end

#postcard_from_name ⇒ Object

Returns the value of attribute postcard_from_name.



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

def postcard_from_name
  @postcard_from_name
end

#postcard_from_postal_code ⇒ Object

Returns the value of attribute postcard_from_postal_code.



41
42
43
 
# File 'lib/ultracart_api/models/email_settings.rb', line 41

def postcard_from_postal_code
  @postcard_from_postal_code
end

#postcard_from_state ⇒ Object

Returns the value of attribute postcard_from_state.



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

def postcard_from_state
  @postcard_from_state
end

#require_order_within_last ⇒ Object

Require order within last



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

def require_order_within_last
  @require_order_within_last
end

#reviews_io_configured ⇒ Object

True if the Reviews.io integration is configured



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

def reviews_io_configured
  @reviews_io_configured
end

#sms_esp_twilio_uuid ⇒ Object

Returns the value of attribute sms_esp_twilio_uuid.



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

def sms_esp_twilio_uuid
  @sms_esp_twilio_uuid
end

#sms_phone_number ⇒ Object

Returns the value of attribute sms_phone_number.



53
54
55
 
# File 'lib/ultracart_api/models/email_settings.rb', line 53

def sms_phone_number
  @sms_phone_number
end

#transactional_esp_domain_user ⇒ Object

Returns the value of attribute transactional_esp_domain_user.



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

def transactional_esp_domain_user
  @transactional_esp_domain_user
end

#transactional_esp_domain_uuid ⇒ Object

Returns the value of attribute transactional_esp_domain_uuid.



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

def transactional_esp_domain_uuid
  @transactional_esp_domain_uuid
end

#transactional_esp_friendly_name ⇒ Object

Returns the value of attribute transactional_esp_friendly_name.



59
60
61
 
# File 'lib/ultracart_api/models/email_settings.rb', line 59

def transactional_esp_friendly_name
  @transactional_esp_friendly_name
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/ultracart_api/models/email_settings.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ultracart_api/models/email_settings.rb', line 62

def self.attribute_map
  {
    :'emails_per_day' => :'emails_per_day',
    :'emails_per_hour' => :'emails_per_hour',
    :'emails_per_month' => :'emails_per_month',
    :'marketing_esp_domain_user' => :'marketing_esp_domain_user',
    :'marketing_esp_domain_uuid' => :'marketing_esp_domain_uuid',
    :'marketing_esp_friendly_name' => :'marketing_esp_friendly_name',
    :'postcard_from_address1' => :'postcard_from_address1',
    :'postcard_from_address2' => :'postcard_from_address2',
    :'postcard_from_city' => :'postcard_from_city',
    :'postcard_from_name' => :'postcard_from_name',
    :'postcard_from_postal_code' => :'postcard_from_postal_code',
    :'postcard_from_state' => :'postcard_from_state',
    :'require_order_within_last' => :'require_order_within_last',
    :'reviews_io_configured' => :'reviews_io_configured',
    :'sms_esp_twilio_uuid' => :'sms_esp_twilio_uuid',
    :'sms_phone_number' => :'sms_phone_number',
    :'transactional_esp_domain_user' => :'transactional_esp_domain_user',
    :'transactional_esp_domain_uuid' => :'transactional_esp_domain_uuid',
    :'transactional_esp_friendly_name' => :'transactional_esp_friendly_name'
  }
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



268
269
270
 
# File 'lib/ultracart_api/models/email_settings.rb', line 268

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/ultracart_api/models/email_settings.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/ultracart_api/models/email_settings.rb', line 92

def self.openapi_types
  {
    :'emails_per_day' => :'Integer',
    :'emails_per_hour' => :'Integer',
    :'emails_per_month' => :'Integer',
    :'marketing_esp_domain_user' => :'String',
    :'marketing_esp_domain_uuid' => :'String',
    :'marketing_esp_friendly_name' => :'String',
    :'postcard_from_address1' => :'String',
    :'postcard_from_address2' => :'String',
    :'postcard_from_city' => :'String',
    :'postcard_from_name' => :'String',
    :'postcard_from_postal_code' => :'String',
    :'postcard_from_state' => :'String',
    :'require_order_within_last' => :'Integer',
    :'reviews_io_configured' => :'Boolean',
    :'sms_esp_twilio_uuid' => :'String',
    :'sms_phone_number' => :'String',
    :'transactional_esp_domain_user' => :'String',
    :'transactional_esp_domain_uuid' => :'String',
    :'transactional_esp_friendly_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/ultracart_api/models/email_settings.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      emails_per_day == o.emails_per_day &&
      emails_per_hour == o.emails_per_hour &&
      emails_per_month == o.emails_per_month &&
      marketing_esp_domain_user == o.marketing_esp_domain_user &&
      marketing_esp_domain_uuid == o.marketing_esp_domain_uuid &&
      marketing_esp_friendly_name == o.marketing_esp_friendly_name &&
      postcard_from_address1 == o.postcard_from_address1 &&
      postcard_from_address2 == o.postcard_from_address2 &&
      postcard_from_city == o.postcard_from_city &&
      postcard_from_name == o.postcard_from_name &&
      postcard_from_postal_code == o.postcard_from_postal_code &&
      postcard_from_state == o.postcard_from_state &&
      require_order_within_last == o.require_order_within_last &&
      reviews_io_configured == o.reviews_io_configured &&
      sms_esp_twilio_uuid == o.sms_esp_twilio_uuid &&
      sms_phone_number == o.sms_phone_number &&
      transactional_esp_domain_user == o.transactional_esp_domain_user &&
      transactional_esp_domain_uuid == o.transactional_esp_domain_uuid &&
      transactional_esp_friendly_name == o.transactional_esp_friendly_name
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



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
335
336
 
# File 'lib/ultracart_api/models/email_settings.rb', line 299

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



370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/ultracart_api/models/email_settings.rb', line 370

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



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

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


255
256
257
 
# File 'lib/ultracart_api/models/email_settings.rb', line 255

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



261
262
263
 
# File 'lib/ultracart_api/models/email_settings.rb', line 261

def hash
  [emails_per_day, emails_per_hour, emails_per_month, marketing_esp_domain_user, marketing_esp_domain_uuid, marketing_esp_friendly_name, postcard_from_address1, postcard_from_address2, postcard_from_city, postcard_from_name, postcard_from_postal_code, postcard_from_state, require_order_within_last, reviews_io_configured, sms_esp_twilio_uuid, sms_phone_number, transactional_esp_domain_user, transactional_esp_domain_uuid, transactional_esp_friendly_name].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



216
217
218
219
 
# File 'lib/ultracart_api/models/email_settings.rb', line 216

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



346
347
348
 
# File 'lib/ultracart_api/models/email_settings.rb', line 346

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



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/ultracart_api/models/email_settings.rb', line 352

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



340
341
342
 
# File 'lib/ultracart_api/models/email_settings.rb', line 340

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



223
224
225
 
# File 'lib/ultracart_api/models/email_settings.rb', line 223

def valid?
  true
end