Class: Inttegro::FileLink::PageRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/file_link/page_request.rb

Overview

Typed representation of the page request object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#file_id ⇒ String? (readonly)

Value of the file_id field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: file_id.

Returns:

  • (String, nil) 


42
43
44
45
46
47
 
# File 'lib/inttegro/file_link/page_request.rb', line 42

class PageRequest < T::Struct
  const :file_id, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::FileLink::Status), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
end

#page_number ⇒ Integer? (readonly)

Value of the page_number field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: page_number.

Returns:

  • (Integer, nil) 


42
43
44
45
46
47
 
# File 'lib/inttegro/file_link/page_request.rb', line 42

class PageRequest < T::Struct
  const :file_id, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::FileLink::Status), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
end

#page_size ⇒ Integer? (readonly)

Value of the page_size field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: page_size.

Returns:

  • (Integer, nil) 


42
43
44
45
46
47
 
# File 'lib/inttegro/file_link/page_request.rb', line 42

class PageRequest < T::Struct
  const :file_id, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::FileLink::Status), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
end

#status ⇒ Inttegro::FileLink::Status? (readonly)

Value of the status field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: status.

Returns:



42
43
44
45
46
47
 
# File 'lib/inttegro/file_link/page_request.rb', line 42

class PageRequest < T::Struct
  const :file_id, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::FileLink::Status), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
end