Class: FattureInCloud_Ruby_Sdk::ListReceivedDocumentsResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListReceivedDocumentsResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
187
188
189
190
191
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 128

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FattureInCloud_Ruby_Sdk::ListReceivedDocumentsResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FattureInCloud_Ruby_Sdk::ListReceivedDocumentsResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#current_page ⇒ Object

Current page number.



20
21
22
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 20

def current_page
  @current_page
end

#data ⇒ Object

Returns the value of attribute data.



52
53
54
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 52

def data
  @data
end

#first_page_url ⇒ Object

First page url.



23
24
25
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 23

def first_page_url
  @first_page_url
end

#from ⇒ Object

First result of the page.



26
27
28
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 26

def from
  @from
end

#last_page ⇒ Object

Last page number.



29
30
31
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 29

def last_page
  @last_page
end

#last_page_url ⇒ Object

Last page url.



32
33
34
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 32

def last_page_url
  @last_page_url
end

#next_page_url ⇒ Object

Next page url



35
36
37
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 35

def next_page_url
  @next_page_url
end

#path ⇒ Object

Request path.



38
39
40
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 38

def path
  @path
end

#per_page ⇒ Object

Number of result per page.



41
42
43
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 41

def per_page
  @per_page
end

#prev_page_url ⇒ Object

Previous page url.



44
45
46
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 44

def prev_page_url
  @prev_page_url
end

#to ⇒ Object

Last result of the page.



47
48
49
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 47

def to
  @to
end

#total ⇒ Object

Total number of results



50
51
52
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 50

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



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
302
303
304
305
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 266

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
  when :Hash
    value
  else # model
    # models (e.g. Pet) or oneOf
    klass = FattureInCloud_Ruby_Sdk.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



73
74
75
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 73

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 78

def self.acceptable_attributes
  acceptable_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
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 55

def self.attribute_map
  {
    :'current_page' => :'current_page',
    :'first_page_url' => :'first_page_url',
    :'from' => :'from',
    :'last_page' => :'last_page',
    :'last_page_url' => :'last_page_url',
    :'next_page_url' => :'next_page_url',
    :'path' => :'path',
    :'per_page' => :'per_page',
    :'prev_page_url' => :'prev_page_url',
    :'to' => :'to',
    :'total' => :'total',
    :'data' => :'data'
  }
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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 242

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



119
120
121
122
123
124
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 119

def self.openapi_all_of
  [
  :'ListReceivedDocumentsResponsePage',
  :'Pagination'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 101

def self.openapi_nullable
  Set.new([
    :'current_page',
    :'first_page_url',
    :'from',
    :'last_page',
    :'last_page_url',
    :'next_page_url',
    :'path',
    :'per_page',
    :'prev_page_url',
    :'to',
    :'total',
    :'data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 83

def self.openapi_types
  {
    :'current_page' => :'Integer',
    :'first_page_url' => :'String',
    :'from' => :'Integer',
    :'last_page' => :'Integer',
    :'last_page_url' => :'String',
    :'next_page_url' => :'String',
    :'path' => :'String',
    :'per_page' => :'Integer',
    :'prev_page_url' => :'String',
    :'to' => :'Integer',
    :'total' => :'Integer',
    :'data' => :'Array<ReceivedDocument>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      current_page == o.current_page &&
      first_page_url == o.first_page_url &&
      from == o.from &&
      last_page == o.last_page &&
      last_page_url == o.last_page_url &&
      next_page_url == o.next_page_url &&
      path == o.path &&
      per_page == o.per_page &&
      prev_page_url == o.prev_page_url &&
      to == o.to &&
      total == o.total &&
      data == o.data
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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 339

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


229
230
231
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



235
236
237
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 235

def hash
  [current_page, first_page_url, from, last_page, last_page_url, next_page_url, path, per_page, prev_page_url, to, total, data].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



195
196
197
198
199
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 195

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



315
316
317
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 315

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 321

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



309
310
311
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 309

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



203
204
205
206
 
# File 'lib/fattureincloud_ruby_sdk/models/list_received_documents_response.rb', line 203

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