Class: ConnectWise::Adjustment

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/models/adjustment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Adjustment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 75

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'effectiveDate')
    self.effective_date = attributes[:'effectiveDate']
  end

  if attributes.has_key?(:'agreementId')
    self.agreement_id = attributes[:'agreementId']
  end

  if attributes.has_key?(:'_info')
    self._info = attributes[:'_info']
  end

  if attributes.has_key?(:'identifier')
    self.identifier = attributes[:'identifier']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'reason')
    self.reason = attributes[:'reason']
  end

  if attributes.has_key?(:'notes')
    self.notes = attributes[:'notes']
  end

  if attributes.has_key?(:'closedFlag')
    self.closed_flag = attributes[:'closedFlag']
  end

  if attributes.has_key?(:'closedBy')
    self.closed_by = attributes[:'closedBy']
  end

  if attributes.has_key?(:'closedDate')
    self.closed_date = attributes[:'closedDate']
  end

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



18
19
20
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 18

def _info
  @_info
end

#agreement_id ⇒ Object

Returns the value of attribute agreement_id.



15
16
17
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 15

def agreement_id
  @agreement_id
end

#amount ⇒ Object

Returns the value of attribute amount.



9
10
11
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 9

def amount
  @amount
end

#closed_by ⇒ Object

Returns the value of attribute closed_by.



30
31
32
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 30

def closed_by
  @closed_by
end

#closed_date ⇒ Object

Returns the value of attribute closed_date.



32
33
34
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 32

def closed_date
  @closed_date
end

#closed_flag ⇒ Object

Returns the value of attribute closed_flag.



28
29
30
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 28

def closed_flag
  @closed_flag
end

#description ⇒ Object

Returns the value of attribute description.



11
12
13
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 11

def description
  @description
end

#effective_date ⇒ Object

Returns the value of attribute effective_date.



13
14
15
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 13

def effective_date
  @effective_date
end

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 7

def id
  @id
end

#identifier ⇒ Object

Returns the value of attribute identifier.



20
21
22
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 20

def identifier
  @identifier
end

#notes ⇒ Object

Returns the value of attribute notes.



26
27
28
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 26

def notes
  @notes
end

#reason ⇒ Object

Returns the value of attribute reason.



24
25
26
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 24

def reason
  @reason
end

#type ⇒ Object

Returns the value of attribute type.



22
23
24
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 22

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 36

def self.attribute_map
  {
    :'id' => :'id',
    :'amount' => :'amount',
    :'description' => :'description',
    :'effective_date' => :'effectiveDate',
    :'agreement_id' => :'agreementId',
    :'_info' => :'_info',
    :'identifier' => :'identifier',
    :'type' => :'type',
    :'reason' => :'reason',
    :'notes' => :'notes',
    :'closed_flag' => :'closedFlag',
    :'closed_by' => :'closedBy',
    :'closed_date' => :'closedDate'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 55

def self.swagger_types
  {
    :'id' => :'Integer',
    :'amount' => :'Float',
    :'description' => :'String',
    :'effective_date' => :'DateTime',
    :'agreement_id' => :'Integer',
    :'_info' => :'Metadata',
    :'identifier' => :'String',
    :'type' => :'AdjustmentTypeReference',
    :'reason' => :'String',
    :'notes' => :'String',
    :'closed_flag' => :'BOOLEAN',
    :'closed_by' => :'String',
    :'closed_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      amount == o.amount &&
      description == o.description &&
      effective_date == o.effective_date &&
      agreement_id == o.agreement_id &&
      _info == o._info &&
      identifier == o.identifier &&
      type == o.type &&
      reason == o.reason &&
      notes == o.notes &&
      closed_flag == o.closed_flag &&
      closed_by == o.closed_by &&
      closed_date == o.closed_date
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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 265

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
    temp_model = ConnectWise.const_get(type).new
    temp_model.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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 331

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 244

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


231
232
233
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



237
238
239
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 237

def hash
  [id, amount, description, effective_date, agreement_id, _info, identifier, type, reason, notes, closed_flag, closed_by, closed_date].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



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/connectwise-ruby-sdk/models/adjustment.rb', line 137

def list_invalid_properties
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 1000
    invalid_properties.push("invalid value for 'description', the character length must be smaller than or equal to 1000.")
  end

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

  if @identifier.to_s.length > 50
    invalid_properties.push("invalid value for 'identifier', the character length must be smaller than or equal to 50.")
  end

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

  if !@reason.nil? && @reason.to_s.length > 100
    invalid_properties.push("invalid value for 'reason', the character length must be smaller than or equal to 100.")
  end

  return 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



311
312
313
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 311

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



317
318
319
320
321
322
323
324
325
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 317

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



305
306
307
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 305

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



164
165
166
167
168
169
170
171
 
# File 'lib/connectwise-ruby-sdk/models/adjustment.rb', line 164

def valid?
  return false if !@description.nil? && @description.to_s.length > 1000
  return false if @identifier.nil?
  return false if @identifier.to_s.length > 50
  return false if @type.nil?
  return false if !@reason.nil? && @reason.to_s.length > 100
  return true
end