Class: MailSlurpClient::Inbox
- Inherits:
-
Object
- Object
- MailSlurpClient::Inbox
- Defined in:
- lib/mailslurp_client/models/inbox.rb
Overview
Representation of an inbox with an email address. Emails can be sent to or from this email address.
Instance Attribute Summary collapse
-
#created_at ⇒ Object
When was the inbox created.
-
#description ⇒ Object
Optional description of an inbox for labelling purposes.
-
#email_address ⇒ Object
The inbox’s email address.
-
#expires_at ⇒ Object
When, if ever, will the inbox expire and be deleted.
-
#favourite ⇒ Object
Is the inbox favourited.
-
#id ⇒ Object
ID of the inbox.
-
#name ⇒ Object
Optional name of the inbox.
-
#tags ⇒ Object
Tags that inbox has been tagged with.
-
#user_id ⇒ Object
ID of user that inbox belongs to.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Inbox
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Inbox
Initializes the object
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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/mailslurp_client/models/inbox.rb', line 83 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::Inbox` 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 `MailSlurpClient::Inbox`. 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?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'email_address') self.email_address = attributes[:'email_address'] end if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end if attributes.key?(:'favourite') self.favourite = attributes[:'favourite'] end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'tags') if (value = attributes[:'tags']).is_a?(Array) self. = value end end if attributes.key?(:'user_id') self.user_id = attributes[:'user_id'] end end |
Instance Attribute Details
#created_at ⇒ Object
When was the inbox created
19 20 21 |
# File 'lib/mailslurp_client/models/inbox.rb', line 19 def created_at @created_at end |
#description ⇒ Object
Optional description of an inbox for labelling purposes
22 23 24 |
# File 'lib/mailslurp_client/models/inbox.rb', line 22 def description @description end |
#email_address ⇒ Object
The inbox’s email address. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints.
25 26 27 |
# File 'lib/mailslurp_client/models/inbox.rb', line 25 def email_address @email_address end |
#expires_at ⇒ Object
When, if ever, will the inbox expire and be deleted. If null then this inbox is permanent and the emails in it won’t be deleted.
28 29 30 |
# File 'lib/mailslurp_client/models/inbox.rb', line 28 def expires_at @expires_at end |
#favourite ⇒ Object
Is the inbox favourited
31 32 33 |
# File 'lib/mailslurp_client/models/inbox.rb', line 31 def favourite @favourite end |
#id ⇒ Object
ID of the inbox
34 35 36 |
# File 'lib/mailslurp_client/models/inbox.rb', line 34 def id @id end |
#name ⇒ Object
Optional name of the inbox. Displayed in the dashboard for easier search
37 38 39 |
# File 'lib/mailslurp_client/models/inbox.rb', line 37 def name @name end |
#tags ⇒ Object
Tags that inbox has been tagged with
40 41 42 |
# File 'lib/mailslurp_client/models/inbox.rb', line 40 def @tags end |
#user_id ⇒ Object
ID of user that inbox belongs to
43 44 45 |
# File 'lib/mailslurp_client/models/inbox.rb', line 43 def user_id @user_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/mailslurp_client/models/inbox.rb', line 46 def self.attribute_map { :'created_at' => :'createdAt', :'description' => :'description', :'email_address' => :'emailAddress', :'expires_at' => :'expiresAt', :'favourite' => :'favourite', :'id' => :'id', :'name' => :'name', :'tags' => :'tags', :'user_id' => :'userId' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
179 180 181 |
# File 'lib/mailslurp_client/models/inbox.rb', line 179 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
76 77 78 79 |
# File 'lib/mailslurp_client/models/inbox.rb', line 76 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/mailslurp_client/models/inbox.rb', line 61 def self.openapi_types { :'created_at' => :'DateTime', :'description' => :'String', :'email_address' => :'String', :'expires_at' => :'DateTime', :'favourite' => :'Boolean', :'id' => :'String', :'name' => :'String', :'tags' => :'Array<String>', :'user_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/mailslurp_client/models/inbox.rb', line 150 def ==(o) return true if self.equal?(o) self.class == o.class && created_at == o.created_at && description == o.description && email_address == o.email_address && expires_at == o.expires_at && favourite == o.favourite && id == o.id && name == o.name && == o. && user_id == o.user_id end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 238 239 240 241 242 |
# File 'lib/mailslurp_client/models/inbox.rb', line 207 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 MailSlurpClient.const_get(type).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
276 277 278 279 280 281 282 283 284 285 286 287 288 |
# File 'lib/mailslurp_client/models/inbox.rb', line 276 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
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/mailslurp_client/models/inbox.rb', line 186 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_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
166 167 168 |
# File 'lib/mailslurp_client/models/inbox.rb', line 166 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
172 173 174 |
# File 'lib/mailslurp_client/models/inbox.rb', line 172 def hash [created_at, description, email_address, expires_at, favourite, id, name, , user_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
137 138 139 140 |
# File 'lib/mailslurp_client/models/inbox.rb', line 137 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
252 253 254 |
# File 'lib/mailslurp_client/models/inbox.rb', line 252 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/mailslurp_client/models/inbox.rb', line 258 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
246 247 248 |
# File 'lib/mailslurp_client/models/inbox.rb', line 246 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
144 145 146 |
# File 'lib/mailslurp_client/models/inbox.rb', line 144 def valid? true end |