Class: Sendpost::SubAccount

Inherits:
Object
  • Object
show all
Defined in:
lib/sendpost_ruby_sdk/models/sub_account.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubAccount

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 150

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Sendpost::SubAccount` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Sendpost::SubAccount`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_key ⇒ Object

API key for the sub-account.



22
23
24
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 22

def api_key
  @api_key
end

#block_reason ⇒ Object

Reason for blocking the sub-account



55
56
57
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 55

def block_reason
  @block_reason
end

#blocked ⇒ Object

Indicates whether the sub-account is blocked



49
50
51
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 49

def blocked
  @blocked
end

#blocked_at ⇒ Object

UNIX epoch nano timestamp when the sub-account was blocked (0 if not blocked)



52
53
54
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 52

def blocked_at
  @blocked_at
end

#created ⇒ Object

UNIX epoch nano timestamp when the sub-account was created.



40
41
42
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 40

def created
  @created
end

#created_by ⇒ Object

Member who created the sub-account



43
44
45
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 43

def created_by
  @created_by
end

#generate_weekly_report ⇒ Object

Indicates whether weekly reports are generated for this sub-account



61
62
63
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 61

def generate_weekly_report
  @generate_weekly_report
end

#handlers ⇒ Object

Handlers associated with the sub-account



64
65
66
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 64

def handlers
  @handlers
end

#hb_exempt ⇒ Object

Indicates whether the sub-account is exempt from hard bounce tracking



58
59
60
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 58

def hb_exempt
  @hb_exempt
end

#id ⇒ Object

Unique ID for the sub-account.



19
20
21
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 19

def id
  @id
end

#is_plus ⇒ Object

Indicates whether the sub-account is a Plus sub-account



37
38
39
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 37

def is_plus
  @is_plus
end

#labels ⇒ Object

Labels associated with the sub-account



28
29
30
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 28

def labels
  @labels
end

#name ⇒ Object

Name of the sub-account.



25
26
27
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 25

def name
  @name
end

#smtp_auths ⇒ Object

SMTP Auths associated with the sub-account



31
32
33
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 31

def smtp_auths
  @smtp_auths
end

#type ⇒ Object

Type of the sub-account



34
35
36
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 34

def type
  @type
end

#updated_by ⇒ Object

Member who updated the sub-account



46
47
48
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 46

def updated_by
  @updated_by
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



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
365
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 328

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 = Sendpost.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



111
112
113
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 111

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



116
117
118
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 116

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'api_key' => :'apiKey',
    :'name' => :'name',
    :'labels' => :'labels',
    :'smtp_auths' => :'smtpAuths',
    :'type' => :'type',
    :'is_plus' => :'isPlus',
    :'created' => :'created',
    :'created_by' => :'created_by',
    :'updated_by' => :'updated_by',
    :'blocked' => :'blocked',
    :'blocked_at' => :'blocked_at',
    :'block_reason' => :'block_reason',
    :'hb_exempt' => :'hb_exempt',
    :'generate_weekly_report' => :'generate_weekly_report',
    :'handlers' => :'handlers'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



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

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



143
144
145
146
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 143

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

.openapi_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 121

def self.openapi_types
  {
    :'id' => :'Integer',
    :'api_key' => :'String',
    :'name' => :'String',
    :'labels' => :'Array<Label>',
    :'smtp_auths' => :'Array<SMTPAuth>',
    :'type' => :'Integer',
    :'is_plus' => :'Boolean',
    :'created' => :'Integer',
    :'created_by' => :'Hash<String, Object>',
    :'updated_by' => :'Hash<String, Object>',
    :'blocked' => :'Boolean',
    :'blocked_at' => :'Integer',
    :'block_reason' => :'String',
    :'hb_exempt' => :'Boolean',
    :'generate_weekly_report' => :'Boolean',
    :'handlers' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 268

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      api_key == o.api_key &&
      name == o.name &&
      labels == o.labels &&
      smtp_auths == o.smtp_auths &&
      type == o.type &&
      is_plus == o.is_plus &&
      created == o.created &&
      created_by == o.created_by &&
      updated_by == o.updated_by &&
      blocked == o.blocked &&
      blocked_at == o.blocked_at &&
      block_reason == o.block_reason &&
      hb_exempt == o.hb_exempt &&
      generate_weekly_report == o.generate_weekly_report &&
      handlers == o.handlers
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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 399

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:

  • to be compared

Returns:

See Also:

  • `==` method


291
292
293
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



297
298
299
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 297

def hash
  [id, api_key, name, labels, smtp_auths, type, is_plus, created, created_by, updated_by, blocked, blocked_at, block_reason, hb_exempt, generate_weekly_report, handlers].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



241
242
243
244
245
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 241

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:

  • Returns the object in the form of hash



375
376
377
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 375

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 381

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 presentation of the object



369
370
371
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 369

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



249
250
251
252
253
254
 
# File 'lib/sendpost_ruby_sdk/models/sub_account.rb', line 249

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('Integer', [0, 1])
  return false unless type_validator.valid?(@type)
  true
end