Class: Inttegro::File::PageRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/file/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

#created_after ⇒ Time? (readonly)

Value of the created_after field in the Inttegro API payload.

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

Returns:

  • (Time, nil) 


54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/file/page_request.rb', line 54

class PageRequest < T::Struct
  const :purpose, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::File::Status), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
  const :created_after, T.nilable(Time), default: nil
  const :created_before, T.nilable(Time), default: nil
end

#created_before ⇒ Time? (readonly)

Value of the created_before field in the Inttegro API payload.

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

Returns:

  • (Time, nil) 


54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/file/page_request.rb', line 54

class PageRequest < T::Struct
  const :purpose, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::File::Status), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
  const :created_after, T.nilable(Time), default: nil
  const :created_before, T.nilable(Time), 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) 


54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/file/page_request.rb', line 54

class PageRequest < T::Struct
  const :purpose, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::File::Status), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
  const :created_after, T.nilable(Time), default: nil
  const :created_before, T.nilable(Time), 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) 


54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/file/page_request.rb', line 54

class PageRequest < T::Struct
  const :purpose, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::File::Status), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
  const :created_after, T.nilable(Time), default: nil
  const :created_before, T.nilable(Time), default: nil
end

#purpose ⇒ String? (readonly)

Value of the purpose field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/file/page_request.rb', line 54

class PageRequest < T::Struct
  const :purpose, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::File::Status), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
  const :created_after, T.nilable(Time), default: nil
  const :created_before, T.nilable(Time), default: nil
end

#status ⇒ Inttegro::File::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:



54
55
56
57
58
59
60
61
 
# File 'lib/inttegro/file/page_request.rb', line 54

class PageRequest < T::Struct
  const :purpose, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::File::Status), default: nil
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, T.nilable(Integer), default: nil
  const :created_after, T.nilable(Time), default: nil
  const :created_before, T.nilable(Time), default: nil
end