Class: ConnectWise::AdjustmentDetail

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AdjustmentDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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

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

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

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

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

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

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

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

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

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

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

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

def _info
  @_info
end

#adjustment ⇒ Object

Returns the value of attribute adjustment.



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

def adjustment
  @adjustment
end

#catalog_item ⇒ Object

Returns the value of attribute catalog_item.



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

def catalog_item
  @catalog_item
end

#description ⇒ Object

Max length: 50;



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

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#quantity_adjusted ⇒ Object

Returns the value of attribute quantity_adjusted.



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

def quantity_adjusted
  @quantity_adjusted
end

#quantity_on_hand ⇒ Object

Returns the value of attribute quantity_on_hand.



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

def quantity_on_hand
  @quantity_on_hand
end

#serial_number ⇒ Object

Max length: 1000;



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

def serial_number
  @serial_number
end

#unit_cost ⇒ Object

Returns the value of attribute unit_cost.



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

def unit_cost
  @unit_cost
end

#warehouse ⇒ Object

Returns the value of attribute warehouse.



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

def warehouse
  @warehouse
end

#warehouse_bin ⇒ Object

Returns the value of attribute warehouse_bin.



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

def warehouse_bin
  @warehouse_bin
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 42

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

def self.attribute_map
  {
    quantity_adjusted: :quantityAdjusted,
    id: :id,
    catalog_item: :catalogItem,
    description: :description,
    quantity_on_hand: :quantityOnHand,
    unit_cost: :unitCost,
    warehouse: :warehouse,
    warehouse_bin: :warehouseBin,
    serial_number: :serialNumber,
    adjustment: :adjustment,
    _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



156
157
158
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 156

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
67
68
69
70
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 64

def self.openapi_nullable
  Set.new(%i[
            quantity_adjusted
            quantity_on_hand
            unit_cost
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 47

def self.openapi_types
  {
    quantity_adjusted: :Integer,
    id: :Integer,
    catalog_item: :CatalogItemReference,
    description: :String,
    quantity_on_hand: :Float,
    unit_cost: :Float,
    warehouse: :WarehouseReference,
    warehouse_bin: :WarehouseBinReference,
    serial_number: :String,
    adjustment: :AdjustmentReference,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 124

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

  self.class == other.class &&
    quantity_adjusted == other.quantity_adjusted &&
    id == other.id &&
    catalog_item == other.catalog_item &&
    description == other.description &&
    quantity_on_hand == other.quantity_on_hand &&
    unit_cost == other.unit_cost &&
    warehouse == other.warehouse &&
    warehouse_bin == other.warehouse_bin &&
    serial_number == other.serial_number &&
    adjustment == other.adjustment &&
    _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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 186

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



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 257

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 163

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


143
144
145
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 143

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



149
150
151
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 149

def hash
  [quantity_adjusted, id, catalog_item, description, quantity_on_hand, unit_cost, warehouse, warehouse_bin, serial_number, adjustment, _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



112
113
114
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 112

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



233
234
235
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 233

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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 239

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



227
228
229
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 227

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



118
119
120
 
# File 'lib/connect_wise/models/adjustment_detail.rb', line 118

def valid?
  true
end