Class: AvalaraSdk::EInvoicing::V1::Mandate

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

Overview

An object representing the country mandate

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Mandate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#country_code ⇒ Object

Country code



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

def country_code
  @country_code
end

#country_mandate ⇒ Object

[LEGACY] This field is retained for backward compatibility. It is recommended to use ‘mandateId` instead. The `countryMandate` similar to the `mandateId` is comprised of the country code, mandate type, and the network or regulation type (for example, AU-B2G-PEPPOL).



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

def country_mandate
  @country_mandate
end

#description ⇒ Object

Mandate description



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

def description
  @description
end

#e_invoicing_flow ⇒ Object

The type of e-invoicing flow for this mandate



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

def e_invoicing_flow
  @e_invoicing_flow
end

#e_invoicing_flow_documentation_link ⇒ Object

Link to the documentation for this mandate’s e-invoicing flow



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

def e_invoicing_flow_documentation_link
  @e_invoicing_flow_documentation_link
end

#get_invoice_available_media_type ⇒ Object

List of available media types for downloading invoices for this mandate



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

def get_invoice_available_media_type
  @get_invoice_available_media_type
end

#input_data_formats ⇒ Object

Format and version used when inputting the data



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

def input_data_formats
  @input_data_formats
end

#mandate_format ⇒ Object

Mandate format



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

def mandate_format
  @mandate_format
end

#mandate_id ⇒ Object

The ‘mandateId` is comprised of the country code, mandate type, and the network or regulation type (for example, AU-B2G-PEPPOL). Keep in mind the following when specifying a `mandateId`. - A country can have multiple mandate types (B2C, B2B, B2G). - A entity/company can opt in for multiple mandates. - A `mandateId` is the combination of country + mandate type + network/regulation.



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

def mandate_id
  @mandate_id
end

#output_data_formats ⇒ Object

Lists the supported output document formats for the country mandate. For countries where specifying an output document format is required (e.g., France), this array will contain the applicable formats. For other countries where output format selection is not necessary, the array will be empty.



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

def output_data_formats
  @output_data_formats
end

#supported_by_elrapi ⇒ Object

Indicates whether this mandate supported by the ELR API



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

def supported_by_elrapi
  @supported_by_elrapi
end

#supports_inbound_digital_document ⇒ Object

Indicates whether this mandate supports inbound digital documents



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

def supports_inbound_digital_document
  @supports_inbound_digital_document
end

#workflow_ids ⇒ Object

Workflow ID list



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

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



253
254
255
256
257
258
259
260
261
262
263
264
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
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 253

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



74
75
76
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 55

def self.attribute_map
  {
    :'mandate_id' => :'mandateId',
    :'country_mandate' => :'countryMandate',
    :'country_code' => :'countryCode',
    :'description' => :'description',
    :'supported_by_elrapi' => :'supportedByELRAPI',
    :'mandate_format' => :'mandateFormat',
    :'e_invoicing_flow' => :'eInvoicingFlow',
    :'e_invoicing_flow_documentation_link' => :'eInvoicingFlowDocumentationLink',
    :'get_invoice_available_media_type' => :'getInvoiceAvailableMediaType',
    :'supports_inbound_digital_document' => :'supportsInboundDigitalDocument',
    :'input_data_formats' => :'inputDataFormats',
    :'output_data_formats' => :'outputDataFormats',
    :'workflow_ids' => :'workflowIds'
  }
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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 229

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



98
99
100
101
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 79

def self.openapi_types
  {
    :'mandate_id' => :'String',
    :'country_mandate' => :'String',
    :'country_code' => :'String',
    :'description' => :'String',
    :'supported_by_elrapi' => :'Boolean',
    :'mandate_format' => :'String',
    :'e_invoicing_flow' => :'String',
    :'e_invoicing_flow_documentation_link' => :'String',
    :'get_invoice_available_media_type' => :'Array<String>',
    :'supports_inbound_digital_document' => :'String',
    :'input_data_formats' => :'Array<InputDataFormats>',
    :'output_data_formats' => :'Array<OutputDataFormats>',
    :'workflow_ids' => :'Array<WorkflowIds>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 196

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      mandate_id == o.mandate_id &&
      country_mandate == o.country_mandate &&
      country_code == o.country_code &&
      description == o.description &&
      supported_by_elrapi == o.supported_by_elrapi &&
      mandate_format == o.mandate_format &&
      e_invoicing_flow == o.e_invoicing_flow &&
      e_invoicing_flow_documentation_link == o.e_invoicing_flow_documentation_link &&
      get_invoice_available_media_type == o.get_invoice_available_media_type &&
      supports_inbound_digital_document == o.supports_inbound_digital_document &&
      input_data_formats == o.input_data_formats &&
      output_data_formats == o.output_data_formats &&
      workflow_ids == o.workflow_ids
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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 324

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


216
217
218
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



222
223
224
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 222

def hash
  [mandate_id, country_mandate, country_code, description, supported_by_elrapi, mandate_format, e_invoicing_flow, e_invoicing_flow_documentation_link, get_invoice_available_media_type, supports_inbound_digital_document, input_data_formats, output_data_formats, workflow_ids].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



181
182
183
184
185
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 181

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



300
301
302
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 300

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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 306

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



294
295
296
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 294

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



189
190
191
192
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/mandate.rb', line 189

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