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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_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



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

def emails_per_day
  @emails_per_day
end

#emails_per_hour ⇒ Object

Emails per hour allowed



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

def emails_per_hour
  @emails_per_hour
end

#emails_per_month ⇒ Object

Emails per month allowed



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

def emails_per_month
  @emails_per_month
end

#marketing_esp_domain_user ⇒ Object

Returns the value of attribute marketing_esp_domain_user.



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

def marketing_esp_domain_user
  @marketing_esp_domain_user
end

#marketing_esp_domain_uuid ⇒ Object

Returns the value of attribute marketing_esp_domain_uuid.



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

def marketing_esp_domain_uuid
  @marketing_esp_domain_uuid
end

#marketing_esp_friendly_name ⇒ Object

Returns the value of attribute marketing_esp_friendly_name.



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

def marketing_esp_friendly_name
  @marketing_esp_friendly_name
end

#postcard_from_address1 ⇒ Object

Returns the value of attribute postcard_from_address1.



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

def postcard_from_address1
  @postcard_from_address1
end

#postcard_from_address2 ⇒ Object

Returns the value of attribute postcard_from_address2.



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

def postcard_from_address2
  @postcard_from_address2
end

#postcard_from_city ⇒ Object

Returns the value of attribute postcard_from_city.



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

def postcard_from_city
  @postcard_from_city
end

#postcard_from_name ⇒ Object

Returns the value of attribute postcard_from_name.



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

def postcard_from_name
  @postcard_from_name
end

#postcard_from_postal_code ⇒ Object

Returns the value of attribute postcard_from_postal_code.



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

def postcard_from_postal_code
  @postcard_from_postal_code
end

#postcard_from_state ⇒ Object

Returns the value of attribute postcard_from_state.



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

def postcard_from_state
  @postcard_from_state
end

#require_order_within_last ⇒ Object

Require order within last



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

def require_order_within_last
  @require_order_within_last
end

#reviews_io_configured ⇒ Object

True if the Reviews.io integration is configured



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

def reviews_io_configured
  @reviews_io_configured
end

#sms_esp_twilio_uuid ⇒ Object

Returns the value of attribute sms_esp_twilio_uuid.



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

def sms_esp_twilio_uuid
  @sms_esp_twilio_uuid
end

#sms_phone_number ⇒ Object

Returns the value of attribute sms_phone_number.



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

def sms_phone_number
  @sms_phone_number
end

#transactional_esp_domain_user ⇒ Object

Returns the value of attribute transactional_esp_domain_user.



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

def transactional_esp_domain_user
  @transactional_esp_domain_user
end

#transactional_esp_domain_uuid ⇒ Object

Returns the value of attribute transactional_esp_domain_uuid.



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

def transactional_esp_domain_uuid
  @transactional_esp_domain_uuid
end

#transactional_esp_friendly_name ⇒ Object

Returns the value of attribute transactional_esp_friendly_name.



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

def transactional_esp_friendly_name
  @transactional_esp_friendly_name
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/ultracart_api/models/email_settings.rb', line 86

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/ultracart_api/models/email_settings.rb', line 210

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



270
271
272
273
274
275
276
277
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
 
# File 'lib/ultracart_api/models/email_settings.rb', line 270

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/ultracart_api/models/email_settings.rb', line 336

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/ultracart_api/models/email_settings.rb', line 249

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


236
237
238
 
# File 'lib/ultracart_api/models/email_settings.rb', line 236

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



242
243
244
 
# File 'lib/ultracart_api/models/email_settings.rb', line 242

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



197
198
199
200
 
# File 'lib/ultracart_api/models/email_settings.rb', line 197

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



316
317
318
 
# File 'lib/ultracart_api/models/email_settings.rb', line 316

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



322
323
324
325
326
327
328
329
330
 
# File 'lib/ultracart_api/models/email_settings.rb', line 322

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



310
311
312
 
# File 'lib/ultracart_api/models/email_settings.rb', line 310

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



204
205
206
 
# File 'lib/ultracart_api/models/email_settings.rb', line 204

def valid?
  true
end