Class: SignwellSDK::Models::V1::DocumentListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/signwell_sdk/models/v1/document_list_response.rb

Overview

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(current_page:, documents:, total_count:, total_pages:, next_page: nil, previous_page: nil) ⇒ Object

List of documents with pagination

Parameters:

  • current_page (Integer)
  • documents (Array<SignwellSDK::Models::V1::Document>)
  • total_count (Integer)
  • total_pages (Integer)
  • next_page (Integer, nil) (defaults to: nil)
  • previous_page (Integer, nil) (defaults to: nil) 



# File 'lib/signwell_sdk/models/v1/document_list_response.rb', line 38

Instance Attribute Details

#current_page ⇒ Integer

Returns:

  • (Integer) 


11
 
# File 'lib/signwell_sdk/models/v1/document_list_response.rb', line 11

required :current_page, Integer

#documents ⇒ Array<SignwellSDK::Models::V1::Document>

Returns:



16
 
# File 'lib/signwell_sdk/models/v1/document_list_response.rb', line 16

required :documents, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Document] }

#next_page ⇒ Integer?

Returns:

  • (Integer, nil) 


31
 
# File 'lib/signwell_sdk/models/v1/document_list_response.rb', line 31

optional :next_page, Integer, nil?: true

#previous_page ⇒ Integer?

Returns:

  • (Integer, nil) 


36
 
# File 'lib/signwell_sdk/models/v1/document_list_response.rb', line 36

optional :previous_page, Integer, nil?: true

#total_count ⇒ Integer

Returns:

  • (Integer) 


21
 
# File 'lib/signwell_sdk/models/v1/document_list_response.rb', line 21

required :total_count, Integer

#total_pages ⇒ Integer

Returns:

  • (Integer) 


26
 
# File 'lib/signwell_sdk/models/v1/document_list_response.rb', line 26

required :total_pages, Integer