Class: ConnectWise::BatchEntry

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError)


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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'lib/connect_wise/models/batch_entry.rb', line 79

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:_info)
  return unless (value = attributes[:_info]).is_a?(Hash)

  self._info = value
end

Instance Attribute Details

#_infoObject

Returns the value of attribute _info.



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

def _info
  @_info
end

#account_numberObject

Returns the value of attribute account_number.



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

def 
  @account_number
end

#account_typeObject

Returns the value of attribute account_type.



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

def 
  @account_type
end

#adjustment_detailObject

Returns the value of attribute adjustment_detail.



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

def adjustment_detail
  @adjustment_detail
end

#costObject

Returns the value of attribute cost.



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

def cost
  @cost
end

#cost_of_goods_sold_account_numberObject

Returns the value of attribute cost_of_goods_sold_account_number.



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

def 
  @cost_of_goods_sold_account_number
end

#creditObject

Returns the value of attribute credit.



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

def credit
  @credit
end

#debitObject

Returns the value of attribute debit.



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

def debit
  @debit
end

#expenseObject

Returns the value of attribute expense.



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

def expense
  @expense
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#invoiceObject

Returns the value of attribute invoice.



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

def invoice
  @invoice
end

#itemObject

Returns the value of attribute item.



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

def item
  @item
end

#line_itemObject

Returns the value of attribute line_item.



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

def line_item
  @line_item
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#purchase_orderObject

Returns the value of attribute purchase_order.



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

def purchase_order
  @purchase_order
end

#sales_codeObject

Returns the value of attribute sales_code.



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

def sales_code
  @sales_code
end

#transferObject

Returns the value of attribute transfer.



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

def transfer
  @transfer
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    id: :id,
    account_type: :accountType,
    name: :name,
    account_number: :accountNumber,
    debit: :debit,
    credit: :credit,
    cost: :cost,
    item: :item,
    sales_code: :salesCode,
    cost_of_goods_sold_account_number: :costOfGoodsSoldAccountNumber,
    invoice: :invoice,
    purchase_order: :purchaseOrder,
    line_item: :lineItem,
    transfer: :transfer,
    expense: :expense,
    adjustment_detail: :adjustmentDetail,
    _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/batch_entry.rb', line 179

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

.openapi_nullableObject

List of attributes with nullable: true



70
71
72
73
74
75
# File 'lib/connect_wise/models/batch_entry.rb', line 70

def self.openapi_nullable
  Set.new(%i[
            debit
            credit
          ])
end

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    id: :Integer,
    account_type: :String,
    name: :String,
    account_number: :String,
    debit: :Float,
    credit: :Float,
    cost: :Float,
    item: :String,
    sales_code: :String,
    cost_of_goods_sold_account_number: :String,
    invoice: :InvoiceReference,
    purchase_order: :PurchaseOrderReference,
    line_item: :PurchaseOrderLineItemReference,
    transfer: :String,
    expense: :ExpenseDetailReference,
    adjustment_detail: :AdjustmentDetailReference,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



141
142
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/batch_entry.rb', line 141

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

  self.class == other.class &&
    id == other.id &&
     == other. &&
    name == other.name &&
     == other. &&
    debit == other.debit &&
    credit == other.credit &&
    cost == other.cost &&
    item == other.item &&
    sales_code == other.sales_code &&
     == other. &&
    invoice == other.invoice &&
    purchase_order == other.purchase_order &&
    line_item == other.line_item &&
    transfer == other.transfer &&
    expense == other.expense &&
    adjustment_detail == other.adjustment_detail &&
    _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/batch_entry.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/batch_entry.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/batch_entry.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/batch_entry.rb', line 166

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



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

def hash
  [id, , name, , debit, credit, cost, item, sales_code, , invoice, purchase_order, line_item, transfer, expense, adjustment_detail, _info].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



129
130
131
# File 'lib/connect_wise/models/batch_entry.rb', line 129

def list_invalid_properties
  []
end

#to_bodyHash

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/batch_entry.rb', line 256

def to_body
  to_hash
end

#to_hashHash

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/batch_entry.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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



250
251
252
# File 'lib/connect_wise/models/batch_entry.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



135
136
137
# File 'lib/connect_wise/models/batch_entry.rb', line 135

def valid?
  true
end