Class: ConnectWise::ProductComponent

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProductComponent

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

def _info
  @_info
end

#catalog_item ⇒ Object

Returns the value of attribute catalog_item.



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

def catalog_item
  @catalog_item
end

#cost ⇒ Object

Returns the value of attribute cost.



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

def cost
  @cost
end

#hide_description_flag ⇒ Object

Returns the value of attribute hide_description_flag.



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

def hide_description_flag
  @hide_description_flag
end

#hide_extended_price_flag ⇒ Object

Returns the value of attribute hide_extended_price_flag.



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

def hide_extended_price_flag
  @hide_extended_price_flag
end

#hide_item_identifier_flag ⇒ Object

Returns the value of attribute hide_item_identifier_flag.



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

def hide_item_identifier_flag
  @hide_item_identifier_flag
end

#hide_price_flag ⇒ Object

Returns the value of attribute hide_price_flag.



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

def hide_price_flag
  @hide_price_flag
end

#hide_quantity_flag ⇒ Object

Returns the value of attribute hide_quantity_flag.



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

def hide_quantity_flag
  @hide_quantity_flag
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#parent_product_item ⇒ Object

Returns the value of attribute parent_product_item.



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

def parent_product_item
  @parent_product_item
end

#price ⇒ Object

Returns the value of attribute price.



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

def price
  @price
end

#product_item ⇒ Object

Returns the value of attribute product_item.



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

def product_item
  @product_item
end

#quantity ⇒ Object

Returns the value of attribute quantity.



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

def quantity
  @quantity
end

#sequence_number ⇒ Object

Required On Updates;



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

def sequence_number
  @sequence_number
end

#vendor ⇒ Object

Returns the value of attribute vendor.



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

def vendor
  @vendor
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/connect_wise/models/product_component.rb', line 43

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/connect_wise/models/product_component.rb', line 22

def self.attribute_map
  {
    quantity: :quantity,
    id: :id,
    sequence_number: :sequenceNumber,
    catalog_item: :catalogItem,
    hide_price_flag: :hidePriceFlag,
    hide_item_identifier_flag: :hideItemIdentifierFlag,
    hide_description_flag: :hideDescriptionFlag,
    hide_quantity_flag: :hideQuantityFlag,
    hide_extended_price_flag: :hideExtendedPriceFlag,
    vendor: :vendor,
    parent_product_item: :parentProductItem,
    product_item: :productItem,
    price: :price,
    cost: :cost,
    _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



179
180
181
 
# File 'lib/connect_wise/models/product_component.rb', line 179

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/connect_wise/models/product_component.rb', line 69

def self.openapi_nullable
  Set.new(%i[
            quantity
            sequence_number
            hide_price_flag
            hide_item_identifier_flag
            hide_description_flag
            hide_quantity_flag
            hide_extended_price_flag
            price
            cost
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    quantity: :Float,
    id: :Integer,
    sequence_number: :Integer,
    catalog_item: :CatalogItemReference,
    hide_price_flag: :Boolean,
    hide_item_identifier_flag: :Boolean,
    hide_description_flag: :Boolean,
    hide_quantity_flag: :Boolean,
    hide_extended_price_flag: :Boolean,
    vendor: :CompanyReference,
    parent_product_item: :ProductItemReference,
    product_item: :ProductItemReference,
    price: :Float,
    cost: :Float,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/connect_wise/models/product_component.rb', line 143

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

  self.class == other.class &&
    quantity == other.quantity &&
    id == other.id &&
    sequence_number == other.sequence_number &&
    catalog_item == other.catalog_item &&
    hide_price_flag == other.hide_price_flag &&
    hide_item_identifier_flag == other.hide_item_identifier_flag &&
    hide_description_flag == other.hide_description_flag &&
    hide_quantity_flag == other.hide_quantity_flag &&
    hide_extended_price_flag == other.hide_extended_price_flag &&
    vendor == other.vendor &&
    parent_product_item == other.parent_product_item &&
    product_item == other.product_item &&
    price == other.price &&
    cost == other.cost &&
    _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



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
238
239
240
241
242
243
244
245
246
 
# File 'lib/connect_wise/models/product_component.rb', line 209

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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/connect_wise/models/product_component.rb', line 280

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/connect_wise/models/product_component.rb', line 186

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


166
167
168
 
# File 'lib/connect_wise/models/product_component.rb', line 166

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



172
173
174
 
# File 'lib/connect_wise/models/product_component.rb', line 172

def hash
  [quantity, id, sequence_number, catalog_item, hide_price_flag, hide_item_identifier_flag, hide_description_flag, hide_quantity_flag, hide_extended_price_flag, vendor, parent_product_item, product_item, price, cost, _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



131
132
133
 
# File 'lib/connect_wise/models/product_component.rb', line 131

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



256
257
258
 
# File 'lib/connect_wise/models/product_component.rb', line 256

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/connect_wise/models/product_component.rb', line 262

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



250
251
252
 
# File 'lib/connect_wise/models/product_component.rb', line 250

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



137
138
139
 
# File 'lib/connect_wise/models/product_component.rb', line 137

def valid?
  true
end