Class: ConnectWise::ProcurementSetting

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProcurementSetting

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 124

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

def _info
  @_info
end

#auto_approve_purchase_order_flag ⇒ Object

Returns the value of attribute auto_approve_purchase_order_flag.



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

def auto_approve_purchase_order_flag
  @auto_approve_purchase_order_flag
end

#auto_close_purchase_order_flag ⇒ Object

Returns the value of attribute auto_close_purchase_order_flag.



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

def auto_close_purchase_order_flag
  @auto_close_purchase_order_flag
end

#auto_close_purchase_order_item_flag ⇒ Object

Returns the value of attribute auto_close_purchase_order_item_flag.



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

def auto_close_purchase_order_item_flag
  @auto_close_purchase_order_item_flag
end

#costing_method ⇒ Object

Returns the value of attribute costing_method.



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

def costing_method
  @costing_method
end

#default_product_taxable_flag ⇒ Object

Returns the value of attribute default_product_taxable_flag.



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

def default_product_taxable_flag
  @default_product_taxable_flag
end

#disable_auto_pick_flag ⇒ Object

Returns the value of attribute disable_auto_pick_flag.



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

def disable_auto_pick_flag
  @disable_auto_pick_flag
end

#disable_cost_updates_flag ⇒ Object

Returns the value of attribute disable_cost_updates_flag.



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

def disable_cost_updates_flag
  @disable_cost_updates_flag
end

#disable_negative_inventory_flag ⇒ Object

Returns the value of attribute disable_negative_inventory_flag.



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

def disable_negative_inventory_flag
  @disable_negative_inventory_flag
end

#eori_number ⇒ Object

Max length: 50;



25
26
27
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 25

def eori_number
  @eori_number
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#num_decimal_places ⇒ Object

Returns the value of attribute num_decimal_places.



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

def num_decimal_places
  @num_decimal_places
end

#prefix_suffix_type ⇒ Object

Returns the value of attribute prefix_suffix_type.



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

def prefix_suffix_type
  @prefix_suffix_type
end

#purchase_order_prefix ⇒ Object

Max length: 5;



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

def purchase_order_prefix
  @purchase_order_prefix
end

#purchase_order_suffix ⇒ Object

Max length: 5;



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

def purchase_order_suffix
  @purchase_order_suffix
end

#starting_purchase_order_num ⇒ Object

Returns the value of attribute starting_purchase_order_num.



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

def starting_purchase_order_num
  @starting_purchase_order_num
end

#tax_freight_flag ⇒ Object

Returns the value of attribute tax_freight_flag.



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

def tax_freight_flag
  @tax_freight_flag
end

#tax_purchase_order_flag ⇒ Object

Returns the value of attribute tax_purchase_order_flag.



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

def tax_purchase_order_flag
  @tax_purchase_order_flag
end

#use_vendor_tax_code_flag ⇒ Object

Returns the value of attribute use_vendor_tax_code_flag.



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

def use_vendor_tax_code_flag
  @use_vendor_tax_code_flag
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 49

def self.attribute_map
  {
    starting_purchase_order_num: :startingPurchaseOrderNum,
    costing_method: :costingMethod,
    id: :id,
    purchase_order_prefix: :purchaseOrderPrefix,
    purchase_order_suffix: :purchaseOrderSuffix,
    prefix_suffix_type: :prefixSuffixType,
    disable_cost_updates_flag: :disableCostUpdatesFlag,
    disable_negative_inventory_flag: :disableNegativeInventoryFlag,
    auto_close_purchase_order_flag: :autoClosePurchaseOrderFlag,
    auto_close_purchase_order_item_flag: :autoClosePurchaseOrderItemFlag,
    auto_approve_purchase_order_flag: :autoApprovePurchaseOrderFlag,
    tax_purchase_order_flag: :taxPurchaseOrderFlag,
    tax_freight_flag: :taxFreightFlag,
    use_vendor_tax_code_flag: :useVendorTaxCodeFlag,
    num_decimal_places: :numDecimalPlaces,
    disable_auto_pick_flag: :disableAutoPickFlag,
    default_product_taxable_flag: :defaultProductTaxableFlag,
    eori_number: :eoriNumber,
    _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



259
260
261
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 259

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 104

def self.openapi_nullable
  Set.new(i[
            costing_method
            prefix_suffix_type
            disable_cost_updates_flag
            disable_negative_inventory_flag
            auto_close_purchase_order_flag
            auto_close_purchase_order_item_flag
            auto_approve_purchase_order_flag
            tax_purchase_order_flag
            tax_freight_flag
            use_vendor_tax_code_flag
            num_decimal_places
            disable_auto_pick_flag
            default_product_taxable_flag
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 79

def self.openapi_types
  {
    starting_purchase_order_num: :Integer,
    costing_method: :String,
    id: :Integer,
    purchase_order_prefix: :String,
    purchase_order_suffix: :String,
    prefix_suffix_type: :String,
    disable_cost_updates_flag: :Boolean,
    disable_negative_inventory_flag: :Boolean,
    auto_close_purchase_order_flag: :Boolean,
    auto_close_purchase_order_item_flag: :Boolean,
    auto_approve_purchase_order_flag: :Boolean,
    tax_purchase_order_flag: :Boolean,
    tax_freight_flag: :Boolean,
    use_vendor_tax_code_flag: :Boolean,
    num_decimal_places: :Integer,
    disable_auto_pick_flag: :Boolean,
    default_product_taxable_flag: :Boolean,
    eori_number: :String,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 219

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

  self.class == other.class &&
    starting_purchase_order_num == other.starting_purchase_order_num &&
    costing_method == other.costing_method &&
    id == other.id &&
    purchase_order_prefix == other.purchase_order_prefix &&
    purchase_order_suffix == other.purchase_order_suffix &&
    prefix_suffix_type == other.prefix_suffix_type &&
    disable_cost_updates_flag == other.disable_cost_updates_flag &&
    disable_negative_inventory_flag == other.disable_negative_inventory_flag &&
    auto_close_purchase_order_flag == other.auto_close_purchase_order_flag &&
    auto_close_purchase_order_item_flag == other.auto_close_purchase_order_item_flag &&
    auto_approve_purchase_order_flag == other.auto_approve_purchase_order_flag &&
    tax_purchase_order_flag == other.tax_purchase_order_flag &&
    tax_freight_flag == other.tax_freight_flag &&
    use_vendor_tax_code_flag == other.use_vendor_tax_code_flag &&
    num_decimal_places == other.num_decimal_places &&
    disable_auto_pick_flag == other.disable_auto_pick_flag &&
    default_product_taxable_flag == other.default_product_taxable_flag &&
    eori_number == other.eori_number &&
    _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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 289

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 360

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 266

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


246
247
248
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 246

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



252
253
254
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 252

def hash
  [starting_purchase_order_num, costing_method, id, purchase_order_prefix, purchase_order_suffix, prefix_suffix_type, disable_cost_updates_flag, disable_negative_inventory_flag, auto_close_purchase_order_flag, auto_close_purchase_order_item_flag, auto_approve_purchase_order_flag, tax_purchase_order_flag, tax_freight_flag, use_vendor_tax_code_flag, num_decimal_places, disable_auto_pick_flag, default_product_taxable_flag, eori_number, _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



178
179
180
181
182
183
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 178

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "starting_purchase_order_num", starting_purchase_order_num cannot be nil.') if @starting_purchase_order_num.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



336
337
338
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 336

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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 342

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



330
331
332
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 330

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



187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/connect_wise/models/procurement_setting.rb', line 187

def valid?
  return false if @starting_purchase_order_num.nil?

  costing_method_validator = EnumAttributeValidator.new('String', %w[FIFO LIFO AverageCosting])
  return false unless costing_method_validator.valid?(@costing_method)

  prefix_suffix_type_validator = EnumAttributeValidator.new('String', %w[Prefix Suffix])
  return false unless prefix_suffix_type_validator.valid?(@prefix_suffix_type)

  true
end