Class: AvalaraSdk::EInvoicing::V1::FetchDocumentsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb,
lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb

Overview

Represents the Request object for the FetchDocuments API

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FetchDocumentsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize()
end

Instance Attribute Details

#avalara_version ⇒ Object

Returns the value of attribute avalara_version.



756
757
758
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb', line 756

def avalara_version
  @avalara_version
end

#data ⇒ Object

Array of key-value pairs used to retrieve inbound documents from the Tax Authority



18
19
20
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 18

def data
  @data
end

#document_fetch_request ⇒ Object

Returns the value of attribute document_fetch_request.



758
759
760
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb', line 758

def document_fetch_request
  @document_fetch_request
end

#metadata ⇒ Object

Returns the value of attribute metadata.



20
21
22
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 20

def metadata
  @metadata
end

#x_avalara_client ⇒ Object

Returns the value of attribute x_avalara_client.



760
761
762
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb', line 760

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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



23
24
25
26
27
28
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 23

def self.attribute_map
  {
    :'data' => :'data',
    :'metadata' => :'metadata'
  }
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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 114

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 36

def self.openapi_types
  {
    :'data' => :'Array<FetchDocumentsRequestDataInner>',
    :'metadata' => :'FetchDocumentsRequestMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



92
93
94
95
96
97
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 92

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      data == o.data &&
      metadata == o.metadata
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



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 209

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


101
102
103
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 101

def eql?(o)
  self == o
end

#get_avalara_version ⇒ Object 



765
766
767
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb', line 765

def get_avalara_version()
    return @avalara_version || '1.2'
end

#get_document_fetch_request ⇒ Object 



773
774
775
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb', line 773

def get_document_fetch_request()
    return @document_fetch_request
end

#get_x_avalara_client ⇒ Object 



781
782
783
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb', line 781

def get_x_avalara_client()
    return @x_avalara_client
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



107
108
109
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 107

def hash
  [data, metadata].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#set_avalara_version(avalara_version) ⇒ Object 



769
770
771
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb', line 769

def set_avalara_version(avalara_version)
    @avalara_version = avalara_version
end

#set_document_fetch_request(document_fetch_request) ⇒ Object 



777
778
779
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb', line 777

def set_document_fetch_request(document_fetch_request)
    @document_fetch_request = document_fetch_request
end

#set_x_avalara_client(x_avalara_client) ⇒ Object 



785
786
787
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb', line 785

def set_x_avalara_client(x_avalara_client)
    @x_avalara_client = x_avalara_client
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



185
186
187
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 185

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



191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 191

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



179
180
181
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 179

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



85
86
87
88
 
# File 'lib/avalara_sdk/models/EInvoicing/V1/fetch_documents_request.rb', line 85

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