Class: AvalaraSdk::EInvoicing::V1::TradingPartner

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

Overview

Represents a participant in the Avalara directory.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TradingPartner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 83

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

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

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

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

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

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

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

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

Instance Attribute Details

#addresses ⇒ Object

Returns the value of attribute addresses.



30
31
32
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 30

def addresses
  @addresses
end

#consents ⇒ Object

Returns the value of attribute consents.



35
36
37
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 35

def consents
  @consents
end

#extensions ⇒ Object

Optional array used to carry additional metadata or configuration values that may be required by specific networks. When creating or updating a trading partner, the keys provided in the ‘extensions’ attribute must be selected from a predefined list of supported extensions. Using any unsupported keys will result in a validation error.



38
39
40
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 38

def extensions
  @extensions
end

#id ⇒ Object

Avalara unique ID of the participant in the directory.



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

def id
  @id
end

#identifiers ⇒ Object

A list of identifiers associated with the trading partner. Each identifier should consistently include the fields name, and value to maintain clarity and ensure consistent structure across entries. When creating or updating a trading partner, the attribute ‘name’ must be agreed upon with Avalara to ensure consistency. Failing to adhere to the agreed values will result in a validation error. Further, when creating or updating a trading partner, the value provided for the attribute ‘displayName’ will be ignored and instead retrieved from the standard set of display names maintained.



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

def identifiers
  @identifiers
end

#name ⇒ Object

Name of the participant (typically, the name of the business entity).



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

def name
  @name
end

#network ⇒ Object

The network where the participant is present. When creating or updating a trading partner, the value provided for the attribute ‘network’ will be ignored.



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

def network
  @network
end

#registration_date ⇒ Object

Registration date of the participant if available.



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

def registration_date
  @registration_date
end

#supported_document_types ⇒ Object

A list of document types supported by the trading partner for exchange. Each document type identifier value must match the standard list maintained by Avalara, which includes Peppol and other public network document type identifier schemes and values, as well as any approved partner-specific identifiers. The ‘value’ field must exactly match an entry from the provided document identifier list. Any attempt to submit unsupported document types will result in a validation error. Further, when creating or updating a trading partner, the value provided for the attributes ‘name’ and ‘supportedByAvalara’ will be ignored.



33
34
35
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 33

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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 324

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



56
57
58
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 56

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 41

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'network' => :'network',
    :'registration_date' => :'registrationDate',
    :'identifiers' => :'identifiers',
    :'addresses' => :'addresses',
    :'supported_document_types' => :'supportedDocumentTypes',
    :'consents' => :'consents',
    :'extensions' => :'extensions'
  }
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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 300

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



76
77
78
79
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 61

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'network' => :'String',
    :'registration_date' => :'String',
    :'identifiers' => :'Array<Identifier>',
    :'addresses' => :'Array<Address>',
    :'supported_document_types' => :'Array<SupportedDocumentTypes>',
    :'consents' => :'Consents',
    :'extensions' => :'Array<Extension>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 271

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      network == o.network &&
      registration_date == o.registration_date &&
      identifiers == o.identifiers &&
      addresses == o.addresses &&
      supported_document_types == o.supported_document_types &&
      consents == o.consents &&
      extensions == o.extensions
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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 395

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


287
288
289
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 287

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



293
294
295
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 293

def hash
  [id, name, network, registration_date, identifiers, addresses, supported_document_types, consents, extensions].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



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

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

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

  if @name.to_s.length < 3
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 3.')
  end

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

  if @identifiers.length < 1
    invalid_properties.push('invalid value for "identifiers", number of items must be greater than or equal to 1.')
  end

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

  if @addresses.length < 1
    invalid_properties.push('invalid value for "addresses", number of items must be greater than or equal to 1.')
  end

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

  if @supported_document_types.length < 1
    invalid_properties.push('invalid value for "supported_document_types", number of items must be greater than or equal to 1.')
  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



371
372
373
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 371

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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 377

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



365
366
367
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/trading_partner.rb', line 365

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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 250
  return false if @name.to_s.length < 3
  return false if @identifiers.nil?
  return false if @identifiers.length < 1
  return false if @addresses.nil?
  return false if @addresses.length < 1
  return false if @supported_document_types.nil?
  return false if @supported_document_types.length < 1
  true
end