Class: AvalaraSdk::EInvoicing::V1::DataInputField

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

Overview

The Data Input Field

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataInputField

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accepted_values ⇒ Object

An object representing the acceptable values for this field



36
37
38
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 36

def accepted_values
  @accepted_values
end

#applicable_document_roots ⇒ Object

Returns the value of attribute applicable_document_roots.



21
22
23
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 21

def applicable_document_roots
  @applicable_document_roots
end

#conditional_for ⇒ Object

Returns the value of attribute conditional_for.



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

def conditional_for
  @conditional_for
end

#description ⇒ Object

A description of this field



42
43
44
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 42

def description
  @description
end

#documentation_link ⇒ Object

An example of the content for this field



39
40
41
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 39

def documentation_link
  @documentation_link
end

#example_or_fixed_value ⇒ Object

An example of the content for this field



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

def example_or_fixed_value
  @example_or_fixed_value
end

#field_id ⇒ Object

Field ID



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

def field_id
  @field_id
end

#field_name ⇒ Object

Field name



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

def field_name
  @field_name
end

#id ⇒ Object

Field UUID



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

def id
  @id
end

#is_segment ⇒ Object

Is this a segment of the schema



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

def is_segment
  @is_segment
end

#namespace ⇒ Object

Namespace of this field



27
28
29
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 27

def namespace
  @namespace
end

#not_used_for ⇒ Object

Returns the value of attribute not_used_for.



51
52
53
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 51

def not_used_for
  @not_used_for
end

#optional_for ⇒ Object

Returns the value of attribute optional_for.



53
54
55
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 53

def optional_for
  @optional_for
end

#path ⇒ Object

Path to this field



24
25
26
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 24

def path
  @path
end

#required_for ⇒ Object

Returns the value of attribute required_for.



47
48
49
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 47

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



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
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 264

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'field_id' => :'fieldId',
    :'applicable_document_roots' => :'applicableDocumentRoots',
    :'path' => :'path',
    :'namespace' => :'namespace',
    :'field_name' => :'fieldName',
    :'example_or_fixed_value' => :'exampleOrFixedValue',
    :'accepted_values' => :'acceptedValues',
    :'documentation_link' => :'documentationLink',
    :'description' => :'description',
    :'is_segment' => :'isSegment',
    :'required_for' => :'requiredFor',
    :'conditional_for' => :'conditionalFor',
    :'not_used_for' => :'notUsedFor',
    :'optional_for' => :'optionalFor'
  }
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



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

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



103
104
105
106
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 82

def self.openapi_types
  {
    :'id' => :'String',
    :'field_id' => :'String',
    :'applicable_document_roots' => :'Array<Object>',
    :'path' => :'String',
    :'namespace' => :'String',
    :'field_name' => :'String',
    :'example_or_fixed_value' => :'String',
    :'accepted_values' => :'Object',
    :'documentation_link' => :'String',
    :'description' => :'String',
    :'is_segment' => :'Boolean',
    :'required_for' => :'DataInputFieldRequiredFor',
    :'conditional_for' => :'Array<ConditionalForField>',
    :'not_used_for' => :'DataInputFieldNotUsedFor',
    :'optional_for' => :'DataInputFieldOptionalFor'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      field_id == o.field_id &&
      applicable_document_roots == o.applicable_document_roots &&
      path == o.path &&
      namespace == o.namespace &&
      field_name == o.field_name &&
      example_or_fixed_value == o.example_or_fixed_value &&
      accepted_values == o.accepted_values &&
      documentation_link == o.documentation_link &&
      description == o.description &&
      is_segment == o.is_segment &&
      required_for == o.required_for &&
      conditional_for == o.conditional_for &&
      not_used_for == o.not_used_for &&
      optional_for == o.optional_for
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



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

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


227
228
229
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



233
234
235
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 233

def hash
  [id, field_id, applicable_document_roots, path, namespace, field_name, example_or_fixed_value, accepted_values, documentation_link, description, is_segment, required_for, conditional_for, not_used_for, optional_for].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



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

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



311
312
313
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 311

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



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

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



305
306
307
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/data_input_field.rb', line 305

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



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

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