Class: ShellDataReportingApIs::EIDDocumentResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_data_reporting_ap_is/models/eid_document_response.rb

Overview

EIDDocumentResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(request_id = SKIP, status = SKIP, data = SKIP, page_size = SKIP, page = SKIP, total_pages = SKIP, total_records = SKIP, is_first_page = SKIP, is_last_page = SKIP) ⇒ EIDDocumentResponse

Returns a new instance of EIDDocumentResponse.



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

def initialize(request_id = SKIP, status = SKIP, data = SKIP,
               page_size = SKIP, page = SKIP, total_pages = SKIP,
               total_records = SKIP, is_first_page = SKIP,
               is_last_page = SKIP)
  @request_id = request_id unless request_id == SKIP
  @status = status unless status == SKIP
  @data = data unless data == SKIP
  @page_size = page_size unless page_size == SKIP
  @page = page unless page == SKIP
  @total_pages = total_pages unless total_pages == SKIP
  @total_records = total_records unless total_records == SKIP
  @is_first_page = is_first_page unless is_first_page == SKIP
  @is_last_page = is_last_page unless is_last_page == SKIP
end

Instance Attribute Details

#data ⇒ Array[EIDDocument]

Indicates overall status of the request. Allowed values: SUCCESS, FAILED

Returns:



23
24
25
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 23

def data
  @data
end

#is_first_page ⇒ TrueClass | FalseClass

True if it is the first page, false otherwise

Returns:

  • (TrueClass | FalseClass) 


43
44
45
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 43

def is_first_page
  @is_first_page
end

#is_last_page ⇒ TrueClass | FalseClass

True if it is the last page, false, otherwise.

Returns:

  • (TrueClass | FalseClass) 


47
48
49
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 47

def is_last_page
  @is_last_page
end

#page ⇒ Integer

Current page

Returns:

  • (Integer) 


31
32
33
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 31

def page
  @page
end

#page_size ⇒ Integer

Number of records returned in the response

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 27

def page_size
  @page_size
end

#request_id ⇒ String

UUID (according to RFC 4122 standards) for requests and responses. This will be played back in the response from the request.

Returns:

  • (String) 


15
16
17
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 15

def request_id
  @request_id
end

#status ⇒ String

Indicates overall status of the request. Allowed values: SUCCESS, FAILED

Returns:

  • (String) 


19
20
21
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 19

def status
  @status
end

#total_pages ⇒ Integer

Total number of pages available for the requested data

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 35

def total_pages
  @total_pages
end

#total_records ⇒ Integer

Total number of elements corresponding to the request

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 39

def total_records
  @total_records
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 100

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
  status = hash.key?('Status') ? hash['Status'] : SKIP
  # Parameter is an array, so we need to iterate through it
  data = nil
  unless hash['Data'].nil?
    data = []
    hash['Data'].each do |structure|
      data << (EIDDocument.from_hash(structure) if structure)
    end
  end

  data = SKIP unless hash.key?('Data')
  page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP
  page = hash.key?('Page') ? hash['Page'] : SKIP
  total_pages = hash.key?('TotalPages') ? hash['TotalPages'] : SKIP
  total_records = hash.key?('TotalRecords') ? hash['TotalRecords'] : SKIP
  is_first_page = hash.key?('IsFirstPage') ? hash['IsFirstPage'] : SKIP
  is_last_page = hash.key?('IsLastPage') ? hash['IsLastPage'] : SKIP

  # Create object from extracted values.
  EIDDocumentResponse.new(request_id,
                          status,
                          data,
                          page_size,
                          page,
                          total_pages,
                          total_records,
                          is_first_page,
                          is_last_page)
end

.names ⇒ Object

A mapping from model property names to API property names.



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 50

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['request_id'] = 'RequestId'
  @_hash['status'] = 'Status'
  @_hash['data'] = 'Data'
  @_hash['page_size'] = 'PageSize'
  @_hash['page'] = 'Page'
  @_hash['total_pages'] = 'TotalPages'
  @_hash['total_records'] = 'TotalRecords'
  @_hash['is_first_page'] = 'IsFirstPage'
  @_hash['is_last_page'] = 'IsLastPage'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



80
81
82
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 80

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/shell_data_reporting_ap_is/models/eid_document_response.rb', line 65

def self.optionals
  %w[
    request_id
    status
    data
    page_size
    page
    total_pages
    total_records
    is_first_page
    is_last_page
  ]
end