Class: ElasticEmail::SubaccountEmailSettingsPayload

Inherits:
Object
  • Object
show all
Defined in:
lib/ElasticEmail/models/subaccount_email_settings_payload.rb

Overview

Settings related to sending emails

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubaccountEmailSettingsPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
85
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
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 79

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

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

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

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

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

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

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

Instance Attribute Details

#daily_send_limit ⇒ Object

Amount of emails Account can send daily



26
27
28
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 26

def daily_send_limit
  @daily_send_limit
end

#email_size_limit ⇒ Object

Maximum size of email including attachments in MB’s



23
24
25
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 23

def email_size_limit
  @email_size_limit
end

#enable_private_ip_purchase ⇒ Object

Can the SubAccount purchase Private IP for themselves



32
33
34
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 32

def enable_private_ip_purchase
  @enable_private_ip_purchase
end

#max_contacts ⇒ Object

Maximum number of contacts the Account can have. 0 means that parent account’s limit is used.



29
30
31
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 29

def max_contacts
  @max_contacts
end

#pool_name ⇒ Object

Name of your custom IP Pool to be used in the sending process



35
36
37
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 35

def pool_name
  @pool_name
end

#requires_email_credits ⇒ Object

True, if Account needs credits to send emails. Otherwise, false



20
21
22
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 20

def requires_email_credits
  @requires_email_credits
end

#valid_sender_domain_only ⇒ Object

Returns the value of attribute valid_sender_domain_only.



37
38
39
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 37

def valid_sender_domain_only
  @valid_sender_domain_only
end

Class Method Details

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



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
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 189

def self._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 = ElasticEmail.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 40

def self.attribute_map
  {
    :'requires_email_credits' => :'RequiresEmailCredits',
    :'email_size_limit' => :'EmailSizeLimit',
    :'daily_send_limit' => :'DailySendLimit',
    :'max_contacts' => :'MaxContacts',
    :'enable_private_ip_purchase' => :'EnablePrivateIPPurchase',
    :'pool_name' => :'PoolName',
    :'valid_sender_domain_only' => :'ValidSenderDomainOnly'
  }
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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 165

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
75
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 71

def self.openapi_nullable
  Set.new([
    :'valid_sender_domain_only'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 58

def self.openapi_types
  {
    :'requires_email_credits' => :'Boolean',
    :'email_size_limit' => :'Integer',
    :'daily_send_limit' => :'Integer',
    :'max_contacts' => :'Integer',
    :'enable_private_ip_purchase' => :'Boolean',
    :'pool_name' => :'String',
    :'valid_sender_domain_only' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      requires_email_credits == o.requires_email_credits &&
      email_size_limit == o.email_size_limit &&
      daily_send_limit == o.daily_send_limit &&
      max_contacts == o.max_contacts &&
      enable_private_ip_purchase == o.enable_private_ip_purchase &&
      pool_name == o.pool_name &&
      valid_sender_domain_only == o.valid_sender_domain_only
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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 260

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


152
153
154
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 152

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



158
159
160
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 158

def hash
  [requires_email_credits, email_size_limit, daily_send_limit, max_contacts, enable_private_ip_purchase, pool_name, valid_sender_domain_only].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



123
124
125
126
127
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 123

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



236
237
238
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 236

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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 242

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



230
231
232
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 230

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



131
132
133
134
 
# File 'lib/ElasticEmail/models/subaccount_email_settings_payload.rb', line 131

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end