Class: ConnectWise::ContactNote

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContactNote

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/connect_wise/models/contact_note.rb', line 59

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::ContactNote` 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::ContactNote`. 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.text = attributes[:text] if attributes.key?(:text)

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

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

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

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

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

  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/contact_note.rb', line 16

def _info
  @_info
end

#contact_id ⇒ Object

Returns the value of attribute contact_id.



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

def contact_id
  @contact_id
end

#entered_by ⇒ Object

Returns the value of attribute entered_by.



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

def entered_by
  @entered_by
end

#flagged ⇒ Object

Returns the value of attribute flagged.



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

def flagged
  @flagged
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#text ⇒ Object

Returns the value of attribute text.



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

def text
  @text
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



32
33
34
 
# File 'lib/connect_wise/models/contact_note.rb', line 32

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/connect_wise/models/contact_note.rb', line 19

def self.attribute_map
  {
    text: :text,
    id: :id,
    contact_id: :contactId,
    type: :type,
    flagged: :flagged,
    entered_by: :enteredBy,
    _info: :_info
  }
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



134
135
136
 
# File 'lib/connect_wise/models/contact_note.rb', line 134

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



50
51
52
53
54
55
 
# File 'lib/connect_wise/models/contact_note.rb', line 50

def self.openapi_nullable
  Set.new(i[
            contact_id
            flagged
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/connect_wise/models/contact_note.rb', line 37

def self.openapi_types
  {
    text: :String,
    id: :Integer,
    contact_id: :Integer,
    type: :NoteTypeReference,
    flagged: :Boolean,
    entered_by: :String,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/connect_wise/models/contact_note.rb', line 106

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

  self.class == other.class &&
    text == other.text &&
    id == other.id &&
    contact_id == other.contact_id &&
    type == other.type &&
    flagged == other.flagged &&
    entered_by == other.entered_by &&
    _info == other._info
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



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
 
# File 'lib/connect_wise/models/contact_note.rb', line 164

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:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/connect_wise/models/contact_note.rb', line 235

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/connect_wise/models/contact_note.rb', line 141

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:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


121
122
123
 
# File 'lib/connect_wise/models/contact_note.rb', line 121

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



127
128
129
 
# File 'lib/connect_wise/models/contact_note.rb', line 127

def hash
  [text, id, contact_id, type, flagged, entered_by, _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



89
90
91
92
93
94
 
# File 'lib/connect_wise/models/contact_note.rb', line 89

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "text", text cannot be nil.') if @text.nil?

  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



211
212
213
 
# File 'lib/connect_wise/models/contact_note.rb', line 211

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



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/connect_wise/models/contact_note.rb', line 217

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) —

    String presentation of the object



205
206
207
 
# File 'lib/connect_wise/models/contact_note.rb', line 205

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



98
99
100
101
102
 
# File 'lib/connect_wise/models/contact_note.rb', line 98

def valid?
  return false if @text.nil?

  true
end