Class: AvalaraSdk::EInvoicing::V1::SubmitDocumentMetadata

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

Overview

Key value pairs of metadata for a document submission. dataFormat can be ubl-invoice or ubl-creditnote:
<pre>{ "workflowId": "partner-einvoicing", "dataFormat": "ubl-invoice", "dataFormatVersion": "2.1", "countryCode": "SA", "countryMandate": "SA-Phase1-B2B" }</pre>

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubmitDocumentMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
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
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 68

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

  if attributes.key?(:'data_format')
    self.data_format = attributes[:'data_format']
  else
    self.data_format = nil
  end

  if attributes.key?(:'data_format_version')
    self.data_format_version = attributes[:'data_format_version']
  else
    self.data_format_version = nil
  end

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

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

Instance Attribute Details

#country_code ⇒ Object

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



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

def country_code
  @country_code
end

#country_mandate ⇒ Object

The e-invoicing mandate for the specified country.



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

def country_mandate
  @country_mandate
end

#data_format ⇒ Object

Specifies the data format for this workflow.



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

def data_format
  @data_format
end

#data_format_version ⇒ Object

Specifies the data format version number.



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

def data_format_version
  @data_format_version
end

#workflow_id ⇒ Object

Specifies a unique ID for this workflow.



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

def workflow_id
  @workflow_id
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



203
204
205
206
207
208
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
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 203

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



45
46
47
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 34

def self.attribute_map
  {
    :'workflow_id' => :'workflowId',
    :'data_format' => :'dataFormat',
    :'data_format_version' => :'dataFormatVersion',
    :'country_code' => :'countryCode',
    :'country_mandate' => :'countryMandate'
  }
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 179

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



61
62
63
64
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 61

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 50

def self.openapi_types
  {
    :'workflow_id' => :'String',
    :'data_format' => :'String',
    :'data_format_version' => :'String',
    :'country_code' => :'String',
    :'country_mandate' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



154
155
156
157
158
159
160
161
162
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 154

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      workflow_id == o.workflow_id &&
      data_format == o.data_format &&
      data_format_version == o.data_format_version &&
      country_code == o.country_code &&
      country_mandate == o.country_mandate
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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 274

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


166
167
168
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 166

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



172
173
174
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 172

def hash
  [workflow_id, data_format, data_format_version, country_code, country_mandate].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



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
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 114

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @workflow_id.nil?
    invalid_properties.push('invalid value for "workflow_id", workflow_id cannot be nil.')
  end

  if @data_format.nil?
    invalid_properties.push('invalid value for "data_format", data_format cannot be nil.')
  end

  if @data_format_version.nil?
    invalid_properties.push('invalid value for "data_format_version", data_format_version cannot be nil.')
  end

  if @country_code.nil?
    invalid_properties.push('invalid value for "country_code", country_code cannot be nil.')
  end

  if @country_mandate.nil?
    invalid_properties.push('invalid value for "country_mandate", country_mandate cannot be nil.')
  end

  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



250
251
252
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 250

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



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 256

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



244
245
246
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 244

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



142
143
144
145
146
147
148
149
150
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/submit_document_metadata.rb', line 142

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @workflow_id.nil?
  return false if @data_format.nil?
  return false if @data_format_version.nil?
  return false if @country_code.nil?
  return false if @country_mandate.nil?
  true
end