Class: ShellDataReportingApIs::SearchStatementOfAccountRequest

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

Overview

SearchStatementOfAccountRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(filters = SKIP, page = SKIP, page_size = SKIP) ⇒ SearchStatementOfAccountRequest

Returns a new instance of SearchStatementOfAccountRequest.



47
48
49
50
51
 
# File 'lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb', line 47

def initialize(filters = SKIP, page = SKIP, page_size = SKIP)
  @filters = filters unless filters == SKIP
  @page = page unless page == SKIP
  @page_size = page_size unless page_size == SKIP
end

Instance Attribute Details

#filters ⇒ SearchSOAReq

TODO: Write general description for this method

Returns:



14
15
16
 
# File 'lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb', line 14

def filters
  @filters
end

#page ⇒ Integer

Page number

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb', line 18

def page
  @page
end

#page_size ⇒ Integer

Number of records in page

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb', line 22

def page_size
  @page_size
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  filters = SearchSOAReq.from_hash(hash['Filters']) if hash['Filters']
  page = hash.key?('Page') ? hash['Page'] : SKIP
  page_size = hash.key?('PageSize') ? hash['PageSize'] : SKIP

  # Create object from extracted values.

  SearchStatementOfAccountRequest.new(filters,
                                      page,
                                      page_size)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['filters'] = 'Filters'
  @_hash['page'] = 'Page'
  @_hash['page_size'] = 'PageSize'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
40
 
# File 'lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb', line 34

def self.optionals
  %w[
    filters
    page
    page_size
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



75
76
77
78
79
 
# File 'lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb', line 75

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} filters: #{@filters.inspect}, page: #{@page.inspect}, page_size:"\
  " #{@page_size.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



69
70
71
72
 
# File 'lib/shell_data_reporting_ap_is/models/search_statement_of_account_request.rb', line 69

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} filters: #{@filters}, page: #{@page}, page_size: #{@page_size}>"
end