Class: ConnectWise::PortalConfigurationPasswordEmailSetup

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/models/portal_configuration_password_email_setup.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PortalConfigurationPasswordEmailSetup

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash

Raises:



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/connect_wise/models/portal_configuration_password_email_setup.rb', line 79

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::PortalConfigurationPasswordEmailSetup` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `ConnectWise::PortalConfigurationPasswordEmailSetup`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

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

  self.valid_password_email_use_custom_email_flag = attributes[:valid_password_email_use_custom_email_flag] if attributes.key?(:valid_password_email_use_custom_email_flag)

  self.valid_password_email_from_first_name = attributes[:valid_password_email_from_first_name] if attributes.key?(:valid_password_email_from_first_name)

  self.valid_password_email_from_last_name = attributes[:valid_password_email_from_last_name] if attributes.key?(:valid_password_email_from_last_name)

  self.valid_password_email_from_email = attributes[:valid_password_email_from_email] if attributes.key?(:valid_password_email_from_email)

  self.valid_password_email_subject = attributes[:valid_password_email_subject] if attributes.key?(:valid_password_email_subject)

  self.valid_password_email_body = attributes[:valid_password_email_body] if attributes.key?(:valid_password_email_body)

  self.invalid_password_email_use_custom_email_flag = attributes[:invalid_password_email_use_custom_email_flag] if attributes.key?(:invalid_password_email_use_custom_email_flag)

  self.invalid_password_email_from_first_name = attributes[:invalid_password_email_from_first_name] if attributes.key?(:invalid_password_email_from_first_name)

  self.invalid_password_email_from_last_name = attributes[:invalid_password_email_from_last_name] if attributes.key?(:invalid_password_email_from_last_name)

  self.invalid_password_email_from_email = attributes[:invalid_password_email_from_email] if attributes.key?(:invalid_password_email_from_email)

  self.invalid_password_email_subject = attributes[:invalid_password_email_subject] if attributes.key?(:invalid_password_email_subject)

  self.invalid_password_email_body = attributes[:invalid_password_email_body] if attributes.key?(:invalid_password_email_body)

  return unless attributes.key?(:_info)
  return unless (value = attributes[:_info]).is_a?(Hash)

  self._info = value
end

Instance Attribute Details

#_info ⇒ Object

Returns the value of attribute _info.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def _info
  @_info
end

#id ⇒ Object

Returns the value of attribute id.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def id
  @id
end

#invalid_password_email_body ⇒ Object

Returns the value of attribute invalid_password_email_body.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def invalid_password_email_body
  @invalid_password_email_body
end

#invalid_password_email_from_email ⇒ Object

Required when invalidPasswordEmailUseCustomEmailFlag is true



22
23
24
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 22

def invalid_password_email_from_email
  @invalid_password_email_from_email
end

#invalid_password_email_from_first_name ⇒ Object

Returns the value of attribute invalid_password_email_from_first_name.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def invalid_password_email_from_first_name
  @invalid_password_email_from_first_name
end

#invalid_password_email_from_last_name ⇒ Object

Returns the value of attribute invalid_password_email_from_last_name.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def invalid_password_email_from_last_name
  @invalid_password_email_from_last_name
end

#invalid_password_email_subject ⇒ Object

Returns the value of attribute invalid_password_email_subject.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def invalid_password_email_subject
  @invalid_password_email_subject
end

#invalid_password_email_use_custom_email_flag ⇒ Object

Returns the value of attribute invalid_password_email_use_custom_email_flag.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def invalid_password_email_use_custom_email_flag
  @invalid_password_email_use_custom_email_flag
end

#valid_password_email_body ⇒ Object

Returns the value of attribute valid_password_email_body.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def valid_password_email_body
  @valid_password_email_body
end

#valid_password_email_from_email ⇒ Object

Required when validPasswordEmailUseCustomEmailFlag is true



19
20
21
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 19

def valid_password_email_from_email
  @valid_password_email_from_email
end

#valid_password_email_from_first_name ⇒ Object

Returns the value of attribute valid_password_email_from_first_name.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def valid_password_email_from_first_name
  @valid_password_email_from_first_name
end

#valid_password_email_from_last_name ⇒ Object

Returns the value of attribute valid_password_email_from_last_name.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def valid_password_email_from_last_name
  @valid_password_email_from_last_name
end

#valid_password_email_subject ⇒ Object

Returns the value of attribute valid_password_email_subject.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def valid_password_email_subject
  @valid_password_email_subject
end

#valid_password_email_use_custom_email_flag ⇒ Object

Returns the value of attribute valid_password_email_use_custom_email_flag.



16
17
18
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 16

def valid_password_email_use_custom_email_flag
  @valid_password_email_use_custom_email_flag
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



45
46
47
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 25

def self.attribute_map
  {
    id: :id,
    valid_password_email_use_custom_email_flag: :validPasswordEmailUseCustomEmailFlag,
    valid_password_email_from_first_name: :validPasswordEmailFromFirstName,
    valid_password_email_from_last_name: :validPasswordEmailFromLastName,
    valid_password_email_from_email: :validPasswordEmailFromEmail,
    valid_password_email_subject: :validPasswordEmailSubject,
    valid_password_email_body: :validPasswordEmailBody,
    invalid_password_email_use_custom_email_flag: :invalidPasswordEmailUseCustomEmailFlag,
    invalid_password_email_from_first_name: :invalidPasswordEmailFromFirstName,
    invalid_password_email_from_last_name: :invalidPasswordEmailFromLastName,
    invalid_password_email_from_email: :invalidPasswordEmailFromEmail,
    invalid_password_email_subject: :invalidPasswordEmailSubject,
    invalid_password_email_body: :invalidPasswordEmailBody,
    _info: :_info
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



170
171
172
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 170

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
74
75
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 70

def self.openapi_nullable
  Set.new(i[
            valid_password_email_use_custom_email_flag
            invalid_password_email_use_custom_email_flag
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 50

def self.openapi_types
  {
    id: :Integer,
    valid_password_email_use_custom_email_flag: :Boolean,
    valid_password_email_from_first_name: :String,
    valid_password_email_from_last_name: :String,
    valid_password_email_from_email: :String,
    valid_password_email_subject: :String,
    valid_password_email_body: :String,
    invalid_password_email_use_custom_email_flag: :Boolean,
    invalid_password_email_from_first_name: :String,
    invalid_password_email_from_last_name: :String,
    invalid_password_email_from_email: :String,
    invalid_password_email_subject: :String,
    invalid_password_email_body: :String,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 135

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    valid_password_email_use_custom_email_flag == other.valid_password_email_use_custom_email_flag &&
    valid_password_email_from_first_name == other.valid_password_email_from_first_name &&
    valid_password_email_from_last_name == other.valid_password_email_from_last_name &&
    valid_password_email_from_email == other.valid_password_email_from_email &&
    valid_password_email_subject == other.valid_password_email_subject &&
    valid_password_email_body == other.valid_password_email_body &&
    invalid_password_email_use_custom_email_flag == other.invalid_password_email_use_custom_email_flag &&
    invalid_password_email_from_first_name == other.invalid_password_email_from_first_name &&
    invalid_password_email_from_last_name == other.invalid_password_email_from_last_name &&
    invalid_password_email_from_email == other.invalid_password_email_from_email &&
    invalid_password_email_subject == other.invalid_password_email_subject &&
    invalid_password_email_body == other.invalid_password_email_body &&
    _info == other._info
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



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/connect_wise/models/portal_configuration_password_email_setup.rb', line 200

def _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 = ConnectWise.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 271

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 177

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


157
158
159
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 157

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



163
164
165
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 163

def hash
  [id, valid_password_email_use_custom_email_flag, valid_password_email_from_first_name, valid_password_email_from_last_name, valid_password_email_from_email, valid_password_email_subject, valid_password_email_body, invalid_password_email_use_custom_email_flag, invalid_password_email_from_first_name, invalid_password_email_from_last_name, invalid_password_email_from_email, invalid_password_email_subject, invalid_password_email_body, _info].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
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 123

def list_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



247
248
249
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 247

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



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 253

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



241
242
243
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 241

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



129
130
131
 
# File 'lib/connect_wise/models/portal_configuration_password_email_setup.rb', line 129

def valid?
  true
end