Class: ConnectWise::ExportAccountingBatchRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportAccountingBatchRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 102

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'batchIdentifier')
    self.batch_identifier = attributes[:'batchIdentifier']
  end

  if attributes.has_key?(:'glInterfaceIdentifier')
    self.gl_interface_identifier = attributes[:'glInterfaceIdentifier']
  end

  if attributes.has_key?(:'thruDate')
    self.thru_date = attributes[:'thruDate']
  end

  if attributes.has_key?(:'locationId')
    self.location_id = attributes[:'locationId']
  end

  if attributes.has_key?(:'summarizeInvoices')
    self.summarize_invoices = attributes[:'summarizeInvoices']
  end

  if attributes.has_key?(:'exportInvoicesFlag')
    self.export_invoices_flag = attributes[:'exportInvoicesFlag']
  end

  if attributes.has_key?(:'includedInvoiceIds')
    if (value = attributes[:'includedInvoiceIds']).is_a?(Array)
      self.included_invoice_ids = value
    end
  end

  if attributes.has_key?(:'excludedInvoiceIds')
    if (value = attributes[:'excludedInvoiceIds']).is_a?(Array)
      self.excluded_invoice_ids = value
    end
  end

  if attributes.has_key?(:'exportExpensesFlag')
    self.export_expenses_flag = attributes[:'exportExpensesFlag']
  end

  if attributes.has_key?(:'includedExpenseIds')
    if (value = attributes[:'includedExpenseIds']).is_a?(Array)
      self.included_expense_ids = value
    end
  end

  if attributes.has_key?(:'excludedExpenseIds')
    if (value = attributes[:'excludedExpenseIds']).is_a?(Array)
      self.excluded_expense_ids = value
    end
  end

  if attributes.has_key?(:'exportProductsFlag')
    self.export_products_flag = attributes[:'exportProductsFlag']
  end

  if attributes.has_key?(:'includedProductIds')
    if (value = attributes[:'includedProductIds']).is_a?(Array)
      self.included_product_ids = value
    end
  end

  if attributes.has_key?(:'excludedProductIds')
    if (value = attributes[:'excludedProductIds']).is_a?(Array)
      self.excluded_product_ids = value
    end
  end

end

Instance Attribute Details

#batch_identifier ⇒ Object

Returns the value of attribute batch_identifier.



7
8
9
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 7

def batch_identifier
  @batch_identifier
end

#excluded_expense_ids ⇒ Object

Returns the value of attribute excluded_expense_ids.



29
30
31
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 29

def excluded_expense_ids
  @excluded_expense_ids
end

#excluded_invoice_ids ⇒ Object

Returns the value of attribute excluded_invoice_ids.



22
23
24
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 22

def excluded_invoice_ids
  @excluded_invoice_ids
end

#excluded_product_ids ⇒ Object

Returns the value of attribute excluded_product_ids.



36
37
38
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 36

def excluded_product_ids
  @excluded_product_ids
end

#export_expenses_flag ⇒ Object

Batch export must include invoices, expenses, or products (procurement)



25
26
27
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 25

def export_expenses_flag
  @export_expenses_flag
end

#export_invoices_flag ⇒ Object

Batch export must include invoices, expenses, or products (procurement)



18
19
20
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 18

def export_invoices_flag
  @export_invoices_flag
end

#export_products_flag ⇒ Object

Batch export must include invoices, expenses, or products (procurement)



32
33
34
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 32

def export_products_flag
  @export_products_flag
end

#gl_interface_identifier ⇒ Object

Returns the value of attribute gl_interface_identifier.



9
10
11
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 9

def gl_interface_identifier
  @gl_interface_identifier
end

#included_expense_ids ⇒ Object

Returns the value of attribute included_expense_ids.



27
28
29
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 27

def included_expense_ids
  @included_expense_ids
end

#included_invoice_ids ⇒ Object

Returns the value of attribute included_invoice_ids.



20
21
22
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 20

def included_invoice_ids
  @included_invoice_ids
end

#included_product_ids ⇒ Object

Returns the value of attribute included_product_ids.



34
35
36
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 34

def included_product_ids
  @included_product_ids
end

#location_id ⇒ Object

Returns the value of attribute location_id.



13
14
15
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 13

def location_id
  @location_id
end

#summarize_invoices ⇒ Object

Returns the value of attribute summarize_invoices.



15
16
17
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 15

def summarize_invoices
  @summarize_invoices
end

#thru_date ⇒ Object

Returns the value of attribute thru_date.



11
12
13
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 11

def thru_date
  @thru_date
end

Class Method Details

.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
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 61

def self.attribute_map
  {
    :'batch_identifier' => :'batchIdentifier',
    :'gl_interface_identifier' => :'glInterfaceIdentifier',
    :'thru_date' => :'thruDate',
    :'location_id' => :'locationId',
    :'summarize_invoices' => :'summarizeInvoices',
    :'export_invoices_flag' => :'exportInvoicesFlag',
    :'included_invoice_ids' => :'includedInvoiceIds',
    :'excluded_invoice_ids' => :'excludedInvoiceIds',
    :'export_expenses_flag' => :'exportExpensesFlag',
    :'included_expense_ids' => :'includedExpenseIds',
    :'excluded_expense_ids' => :'excludedExpenseIds',
    :'export_products_flag' => :'exportProductsFlag',
    :'included_product_ids' => :'includedProductIds',
    :'excluded_product_ids' => :'excludedProductIds'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 81

def self.swagger_types
  {
    :'batch_identifier' => :'String',
    :'gl_interface_identifier' => :'String',
    :'thru_date' => :'DateTime',
    :'location_id' => :'Integer',
    :'summarize_invoices' => :'String',
    :'export_invoices_flag' => :'BOOLEAN',
    :'included_invoice_ids' => :'Array<Integer>',
    :'excluded_invoice_ids' => :'Array<Integer>',
    :'export_expenses_flag' => :'BOOLEAN',
    :'included_expense_ids' => :'Array<Integer>',
    :'excluded_expense_ids' => :'Array<Integer>',
    :'export_products_flag' => :'BOOLEAN',
    :'included_product_ids' => :'Array<String>',
    :'excluded_product_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 229

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      batch_identifier == o.batch_identifier &&
      gl_interface_identifier == o.gl_interface_identifier &&
      thru_date == o.thru_date &&
      location_id == o.location_id &&
      summarize_invoices == o.summarize_invoices &&
      export_invoices_flag == o.export_invoices_flag &&
      included_invoice_ids == o.included_invoice_ids &&
      excluded_invoice_ids == o.excluded_invoice_ids &&
      export_expenses_flag == o.export_expenses_flag &&
      included_expense_ids == o.included_expense_ids &&
      excluded_expense_ids == o.excluded_expense_ids &&
      export_products_flag == o.export_products_flag &&
      included_product_ids == o.included_product_ids &&
      excluded_product_ids == o.excluded_product_ids
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
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 284

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = ConnectWise.const_get(type).new
    temp_model.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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 350

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 263

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


250
251
252
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 250

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



256
257
258
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 256

def hash
  [batch_identifier, gl_interface_identifier, thru_date, location_id, summarize_invoices, export_invoices_flag, included_invoice_ids, excluded_invoice_ids, export_expenses_flag, included_expense_ids, excluded_expense_ids, export_products_flag, included_product_ids, excluded_product_ids].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 180

def list_invalid_properties
  invalid_properties = Array.new
  if @batch_identifier.nil?
    invalid_properties.push("invalid value for 'batch_identifier', batch_identifier cannot be nil.")
  end

  if @batch_identifier.to_s.length > 50
    invalid_properties.push("invalid value for 'batch_identifier', the character length must be smaller than or equal to 50.")
  end

  return 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



330
331
332
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 330

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



336
337
338
339
340
341
342
343
344
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 336

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



324
325
326
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 324

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



195
196
197
198
199
200
201
 
# File 'lib/connectwise-ruby-sdk/models/export_accounting_batch_request.rb', line 195

def valid?
  return false if @batch_identifier.nil?
  return false if @batch_identifier.to_s.length > 50
  summarize_invoices_validator = EnumAttributeValidator.new('String', ["Default", "Condensed", "Detailed"])
  return false unless summarize_invoices_validator.valid?(@summarize_invoices)
  return true
end