Class: MailSlurpClient::UpdateDomainOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/update_domain_options.rb

Overview

Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not functionally currently until the domain has been verified. See www.mailslurp.com/guides/custom-domains for help.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDomainOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 43

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

Instance Attribute Details

#catch_all_inbox_id ⇒ Object

Returns the value of attribute catch_all_inbox_id.



18
19
20
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 18

def catch_all_inbox_id
  @catch_all_inbox_id
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 21

def self.attribute_map
  {
    :'catch_all_inbox_id' => :'catchAllInboxId'
  }
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



97
98
99
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 97

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



35
36
37
38
39
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 35

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

.openapi_types ⇒ Object

Attribute type mapping.



28
29
30
31
32
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 28

def self.openapi_types
  {
    :'catch_all_inbox_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



76
77
78
79
80
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 76

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      catch_all_inbox_id == o.catch_all_inbox_id
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



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
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 125

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 194

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 104

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


84
85
86
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 84

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



90
91
92
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 90

def hash
  [catch_all_inbox_id].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



63
64
65
66
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 63

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



170
171
172
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 170

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



176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 176

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



164
165
166
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 164

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



70
71
72
 
# File 'lib/mailslurp_client/models/update_domain_options.rb', line 70

def valid?
  true
end