Class: Sendmux::Management::Generated::Mailbox

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/sendmux_management_generated/models/mailbox.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Mailbox

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 85

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

  if attributes.key?(:'display_name')
    self.display_name = attributes[:'display_name']
  else
    self.display_name = nil
  end

  if attributes.key?(:'email')
    self.email = attributes[:'email']
  else
    self.email = nil
  end

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

  if attributes.key?(:'quota_bytes')
    self.quota_bytes = attributes[:'quota_bytes']
  else
    self.quota_bytes = nil
  end

  if attributes.key?(:'send_scope')
    self.send_scope = attributes[:'send_scope']
  else
    self.send_scope = nil
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end
end

Instance Attribute Details

#created_at ⇒ Object

ISO 8601 creation timestamp



19
20
21
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 19

def created_at
  @created_at
end

#display_name ⇒ Object

Optional display name shown in outbound From headers



22
23
24
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 22

def display_name
  @display_name
end

#email ⇒ Object

Mailbox email address (lowercase)



25
26
27
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 25

def email
  @email
end

#id ⇒ Object

Public ID



28
29
30
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 28

def id
  @id
end

#quota_bytes ⇒ Object

Storage quota in bytes. Current writable tiers are 1 GB, 5 GB, and 50 GB.



31
32
33
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 31

def quota_bytes
  @quota_bytes
end

#send_scope ⇒ Object

Returns the value of attribute send_scope.



33
34
35
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 33

def send_scope
  @send_scope
end

#status ⇒ Object

active | suspended | deleted



36
37
38
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 36

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



52
53
54
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 52

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



57
58
59
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 57

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 39

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'display_name' => :'display_name',
    :'email' => :'email',
    :'id' => :'id',
    :'quota_bytes' => :'quota_bytes',
    :'send_scope' => :'send_scope',
    :'status' => :'status'
  }
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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 246

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



75
76
77
78
79
80
81
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 75

def self.openapi_nullable
  Set.new([
    :'display_name',
    :'quota_bytes',
    :'send_scope',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 62

def self.openapi_types
  {
    :'created_at' => :'String',
    :'display_name' => :'String',
    :'email' => :'String',
    :'id' => :'String',
    :'quota_bytes' => :'Integer',
    :'send_scope' => :'MailboxSendScope',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      display_name == o.display_name &&
      email == o.email &&
      id == o.id &&
      quota_bytes == o.quota_bytes &&
      send_scope == o.send_scope &&
      status == o.status
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


233
234
235
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



239
240
241
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 239

def hash
  [created_at, display_name, email, id, quota_bytes, send_scope, status].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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 144

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @email.nil?
    invalid_properties.push('invalid value for "email", email cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 268

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



168
169
170
171
172
173
174
175
 
# File 'lib/sendmux_management_generated/models/mailbox.rb', line 168

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @created_at.nil?
  return false if @email.nil?
  return false if @id.nil?
  return false if @status.nil?
  true
end