Class: MergeAccountingClient::Item

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_accounting_client/models/item.rb

Overview

# The Item Object ### Description The ‘Item` object refers to the goods involved in a transaction. ### Usage Example Fetch from the `LIST Items` endpoint and view a company’s items.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Item

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/merge_accounting_client/models/item.rb', line 126

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MergeAccountingClient::Item` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MergeAccountingClient::Item`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'remote_id')
    self.remote_id = attributes[:'remote_id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'unit_price')
    self.unit_price = attributes[:'unit_price']
  end

  if attributes.key?(:'purchase_price')
    self.purchase_price = attributes[:'purchase_price']
  end

  if attributes.key?(:'purchase_account')
    self. = attributes[:'purchase_account']
  end

  if attributes.key?(:'sales_account')
    self. = attributes[:'sales_account']
  end

  if attributes.key?(:'company')
    self.company = attributes[:'company']
  end

  if attributes.key?(:'remote_updated_at')
    self.remote_updated_at = attributes[:'remote_updated_at']
  end

  if attributes.key?(:'remote_was_deleted')
    self.remote_was_deleted = attributes[:'remote_was_deleted']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'modified_at')
    self.modified_at = attributes[:'modified_at']
  end

  if attributes.key?(:'field_mappings')
    if (value = attributes[:'field_mappings']).is_a?(Hash)
      self.field_mappings = value
    end
  end

  if attributes.key?(:'remote_data')
    if (value = attributes[:'remote_data']).is_a?(Array)
      self.remote_data = value
    end
  end
end

Instance Attribute Details

#company ⇒ Object

The company the item belongs to.



43
44
45
 
# File 'lib/merge_accounting_client/models/item.rb', line 43

def company
  @company
end

#created_at ⇒ Object

Returns the value of attribute created_at.



51
52
53
 
# File 'lib/merge_accounting_client/models/item.rb', line 51

def created_at
  @created_at
end

#field_mappings ⇒ Object

Returns the value of attribute field_mappings.



56
57
58
 
# File 'lib/merge_accounting_client/models/item.rb', line 56

def field_mappings
  @field_mappings
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_accounting_client/models/item.rb', line 19

def id
  @id
end

#modified_at ⇒ Object

This is the datetime that this object was last updated by Merge



54
55
56
 
# File 'lib/merge_accounting_client/models/item.rb', line 54

def modified_at
  @modified_at
end

#name ⇒ Object

The item’s name.



25
26
27
 
# File 'lib/merge_accounting_client/models/item.rb', line 25

def name
  @name
end

#purchase_account ⇒ Object

References the default account used to record a purchase of the item.



37
38
39
 
# File 'lib/merge_accounting_client/models/item.rb', line 37

def 
  @purchase_account
end

#purchase_price ⇒ Object

The price at which the item is purchased from a vendor.



34
35
36
 
# File 'lib/merge_accounting_client/models/item.rb', line 34

def purchase_price
  @purchase_price
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



58
59
60
 
# File 'lib/merge_accounting_client/models/item.rb', line 58

def remote_data
  @remote_data
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_accounting_client/models/item.rb', line 22

def remote_id
  @remote_id
end

#remote_updated_at ⇒ Object

When the third party’s item note was updated.



46
47
48
 
# File 'lib/merge_accounting_client/models/item.rb', line 46

def remote_updated_at
  @remote_updated_at
end

#remote_was_deleted ⇒ Object

Indicates whether or not this object has been deleted in the third party platform.



49
50
51
 
# File 'lib/merge_accounting_client/models/item.rb', line 49

def remote_was_deleted
  @remote_was_deleted
end

#sales_account ⇒ Object

References the default account used to record a sale.



40
41
42
 
# File 'lib/merge_accounting_client/models/item.rb', line 40

def 
  @sales_account
end

#status ⇒ Object

The item’s status. * ‘ACTIVE` - ACTIVE * `ARCHIVED` - ARCHIVED



28
29
30
 
# File 'lib/merge_accounting_client/models/item.rb', line 28

def status
  @status
end

#unit_price ⇒ Object

The item’s unit price.



31
32
33
 
# File 'lib/merge_accounting_client/models/item.rb', line 31

def unit_price
  @unit_price
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/merge_accounting_client/models/item.rb', line 82

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/merge_accounting_client/models/item.rb', line 61

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'name' => :'name',
    :'status' => :'status',
    :'unit_price' => :'unit_price',
    :'purchase_price' => :'purchase_price',
    :'purchase_account' => :'purchase_account',
    :'sales_account' => :'sales_account',
    :'company' => :'company',
    :'remote_updated_at' => :'remote_updated_at',
    :'remote_was_deleted' => :'remote_was_deleted',
    :'created_at' => :'created_at',
    :'modified_at' => :'modified_at',
    :'field_mappings' => :'field_mappings',
    :'remote_data' => :'remote_data'
  }
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



254
255
256
 
# File 'lib/merge_accounting_client/models/item.rb', line 254

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/merge_accounting_client/models/item.rb', line 108

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'name',
    :'status',
    :'unit_price',
    :'purchase_price',
    :'purchase_account',
    :'sales_account',
    :'company',
    :'remote_updated_at',
    :'field_mappings',
    :'remote_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/merge_accounting_client/models/item.rb', line 87

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'name' => :'String',
    :'status' => :'Status7d1Enum',
    :'unit_price' => :'Float',
    :'purchase_price' => :'Float',
    :'purchase_account' => :'String',
    :'sales_account' => :'String',
    :'company' => :'String',
    :'remote_updated_at' => :'Time',
    :'remote_was_deleted' => :'Boolean',
    :'created_at' => :'Time',
    :'modified_at' => :'Time',
    :'field_mappings' => :'Hash<String, Object>',
    :'remote_data' => :'Array<RemoteData>'
  }
end

Instance Method Details

#==(o) ⇒ 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
 
# File 'lib/merge_accounting_client/models/item.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      name == o.name &&
      status == o.status &&
      unit_price == o.unit_price &&
      purchase_price == o.purchase_price &&
       == o. &&
       == o. &&
      company == o.company &&
      remote_updated_at == o.remote_updated_at &&
      remote_was_deleted == o.remote_was_deleted &&
      created_at == o.created_at &&
      modified_at == o.modified_at &&
      field_mappings == o.field_mappings &&
      remote_data == o.remote_data
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



284
285
286
287
288
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
 
# File 'lib/merge_accounting_client/models/item.rb', line 284

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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 = MergeAccountingClient.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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/merge_accounting_client/models/item.rb', line 355

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/merge_accounting_client/models/item.rb', line 261

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.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
      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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
 
# File 'lib/merge_accounting_client/models/item.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/merge_accounting_client/models/item.rb', line 247

def hash
  [id, remote_id, name, status, unit_price, purchase_price, , , company, remote_updated_at, remote_was_deleted, created_at, modified_at, field_mappings, remote_data].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



206
207
208
209
 
# File 'lib/merge_accounting_client/models/item.rb', line 206

def list_invalid_properties
  invalid_properties = Array.new
  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



331
332
333
 
# File 'lib/merge_accounting_client/models/item.rb', line 331

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/merge_accounting_client/models/item.rb', line 337

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



325
326
327
 
# File 'lib/merge_accounting_client/models/item.rb', line 325

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



213
214
215
 
# File 'lib/merge_accounting_client/models/item.rb', line 213

def valid?
  true
end