Class: AvalaraSdk::EInvoicing::V1::DocumentSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb

Overview

Displays a summary of information about the document

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 115

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AvalaraSdk::EInvoicing::V1::DocumentSummary` 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 `AvalaraSdk::EInvoicing::V1::DocumentSummary`. 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?(:'company_id')
    self.company_id = attributes[:'company_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#company_id ⇒ Object

Unique identifier that represents the company within the system.



19
20
21
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 19

def company_id
  @company_id
end

#country_code ⇒ Object

The two-letter ISO-3166 country code for the country where the document is being submitted



49
50
51
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 49

def country_code
  @country_code
end

#country_mandate ⇒ Object

The e-invoicing mandate for the specified country



52
53
54
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 52

def country_mandate
  @country_mandate
end

#customer_name ⇒ Object

The name of the customer in the transaction



31
32
33
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 31

def customer_name
  @customer_name
end

#document_date ⇒ Object

The document issue date



43
44
45
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 43

def document_date
  @document_date
end

#document_number ⇒ Object

The document number



40
41
42
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 40

def document_number
  @document_number
end

#document_type ⇒ Object

The document type



34
35
36
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 34

def document_type
  @document_type
end

#document_version ⇒ Object

The document version



37
38
39
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 37

def document_version
  @document_version
end

#flow ⇒ Object

The document direction, where issued = ‘out` and received = `in`



46
47
48
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 46

def flow
  @flow
end

#id ⇒ Object

The unique ID for this document



16
17
18
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 16

def id
  @id
end

#interface ⇒ Object

The interface where the document is sent



55
56
57
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 55

def interface
  @interface
end

#process_date_time ⇒ Object

The date and time when the document was processed, displayed in the format YYYY-MM-DDThh:mm:ss



22
23
24
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 22

def process_date_time
  @process_date_time
end

#receiver ⇒ Object

The document recipient based on the interface



58
59
60
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 58

def receiver
  @receiver
end

#status ⇒ Object

The Document status



25
26
27
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 25

def status
  @status
end

#supplier_name ⇒ Object

The name of the supplier in the transaction



28
29
30
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 28

def supplier_name
  @supplier_name
end

Class Method Details

._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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 265

def self._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 = AvalaraSdk::EInvoicing::V1.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.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/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 61

def self.attribute_map
  {
    :'id' => :'id',
    :'company_id' => :'companyId',
    :'process_date_time' => :'processDateTime',
    :'status' => :'status',
    :'supplier_name' => :'supplierName',
    :'customer_name' => :'customerName',
    :'document_type' => :'documentType',
    :'document_version' => :'documentVersion',
    :'document_number' => :'documentNumber',
    :'document_date' => :'documentDate',
    :'flow' => :'flow',
    :'country_code' => :'countryCode',
    :'country_mandate' => :'countryMandate',
    :'interface' => :'interface',
    :'receiver' => :'receiver'
  }
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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 241

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 108

def self.openapi_nullable
  Set.new([
  ])
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/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 87

def self.openapi_types
  {
    :'id' => :'String',
    :'company_id' => :'String',
    :'process_date_time' => :'String',
    :'status' => :'String',
    :'supplier_name' => :'String',
    :'customer_name' => :'String',
    :'document_type' => :'String',
    :'document_version' => :'String',
    :'document_number' => :'String',
    :'document_date' => :'String',
    :'flow' => :'String',
    :'country_code' => :'String',
    :'country_mandate' => :'String',
    :'interface' => :'String',
    :'receiver' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      company_id == o.company_id &&
      process_date_time == o.process_date_time &&
      status == o.status &&
      supplier_name == o.supplier_name &&
      customer_name == o.customer_name &&
      document_type == o.document_type &&
      document_version == o.document_version &&
      document_number == o.document_number &&
      document_date == o.document_date &&
      flow == o.flow &&
      country_code == o.country_code &&
      country_mandate == o.country_mandate &&
      interface == o.interface &&
      receiver == o.receiver
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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 336

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


228
229
230
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



234
235
236
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 234

def hash
  [id, company_id, process_date_time, status, supplier_name, customer_name, document_type, document_version, document_number, document_date, flow, country_code, country_mandate, interface, receiver].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



191
192
193
194
195
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 191

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



312
313
314
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 312

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 318

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



306
307
308
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 306

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



199
200
201
202
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/document_summary.rb', line 199

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end