Class: ConnectWise::CatalogItemInfo

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogItemInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 102

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

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

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

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

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

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

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

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

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

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

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

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

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

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

def _info
  @_info
end

#cost ⇒ Object

Returns the value of attribute cost.



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

def cost
  @cost
end

#customer_description ⇒ Object

Returns the value of attribute customer_description.



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

def customer_description
  @customer_description
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#drop_ship_flag ⇒ Object

Returns the value of attribute drop_ship_flag.



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

def drop_ship_flag
  @drop_ship_flag
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#identifier ⇒ Object

Returns the value of attribute identifier.



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

def identifier
  @identifier
end

#inactive_flag ⇒ Object

Returns the value of attribute inactive_flag.



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

def inactive_flag
  @inactive_flag
end

#manufacturer_part_number ⇒ Object

Returns the value of attribute manufacturer_part_number.



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

def manufacturer_part_number
  @manufacturer_part_number
end

#price ⇒ Object

Returns the value of attribute price.



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

def price
  @price
end

#product_class ⇒ Object

Returns the value of attribute product_class.



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

def product_class
  @product_class
end

#serialized_cost_flag ⇒ Object

Returns the value of attribute serialized_cost_flag.



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

def serialized_cost_flag
  @serialized_cost_flag
end

#special_order_flag ⇒ Object

Returns the value of attribute special_order_flag.



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

def special_order_flag
  @special_order_flag
end

#taxable_flag ⇒ Object

Returns the value of attribute taxable_flag.



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

def taxable_flag
  @taxable_flag
end

#vendor_sku ⇒ Object

Returns the value of attribute vendor_sku.



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

def vendor_sku
  @vendor_sku
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 40

def self.attribute_map
  {
    id: :id,
    identifier: :identifier,
    description: :description,
    inactive_flag: :inactiveFlag,
    product_class: :productClass,
    serialized_cost_flag: :serializedCostFlag,
    price: :price,
    cost: :cost,
    taxable_flag: :taxableFlag,
    drop_ship_flag: :dropShipFlag,
    special_order_flag: :specialOrderFlag,
    customer_description: :customerDescription,
    manufacturer_part_number: :manufacturerPartNumber,
    vendor_sku: :vendorSku,
    _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



208
209
210
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 208

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 87

def self.openapi_nullable
  Set.new(%i[
            inactive_flag
            product_class
            serialized_cost_flag
            price
            cost
            taxable_flag
            drop_ship_flag
            special_order_flag
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 66

def self.openapi_types
  {
    id: :Integer,
    identifier: :String,
    description: :String,
    inactive_flag: :Boolean,
    product_class: :String,
    serialized_cost_flag: :Boolean,
    price: :Float,
    cost: :Float,
    taxable_flag: :Boolean,
    drop_ship_flag: :Boolean,
    special_order_flag: :Boolean,
    customer_description: :String,
    manufacturer_part_number: :String,
    vendor_sku: :String,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 172

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

  self.class == other.class &&
    id == other.id &&
    identifier == other.identifier &&
    description == other.description &&
    inactive_flag == other.inactive_flag &&
    product_class == other.product_class &&
    serialized_cost_flag == other.serialized_cost_flag &&
    price == other.price &&
    cost == other.cost &&
    taxable_flag == other.taxable_flag &&
    drop_ship_flag == other.drop_ship_flag &&
    special_order_flag == other.special_order_flag &&
    customer_description == other.customer_description &&
    manufacturer_part_number == other.manufacturer_part_number &&
    vendor_sku == other.vendor_sku &&
    _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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 238

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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 309

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 215

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


195
196
197
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 195

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



201
202
203
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 201

def hash
  [id, identifier, description, inactive_flag, product_class, serialized_cost_flag, price, cost, taxable_flag, drop_ship_flag, special_order_flag, customer_description, manufacturer_part_number, vendor_sku, _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



148
149
150
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 148

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



285
286
287
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 285

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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 291

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



279
280
281
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 279

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



154
155
156
157
158
159
 
# File 'lib/connect_wise/models/catalog_item_info.rb', line 154

def valid?
  product_class_validator = EnumAttributeValidator.new('String', %w[Agreement Bundle Inventory NonInventory Service])
  return false unless product_class_validator.valid?(@product_class)

  true
end