Class: Inttegro::UploadRequest::PageRequest

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

#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) 


49
50
51
52
53
54
55
 
# File 'lib/inttegro/upload_request/page_request.rb', line 49

class PageRequest < T::Struct
  const :purpose, T.nilable(String), default: nil
  const :status, T.nilable(Inttegro::UploadRequest::Status), default: nil
  const :resource, T.nilable(Inttegro::File::Resource), 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) 


49
50
51
52
53
54
55
 
# File 'lib/inttegro/upload_request/page_request.rb', line 49

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


49
50
51
52
53
54
55
 
# File 'lib/inttegro/upload_request/page_request.rb', line 49

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

#resource ⇒ Inttegro::File::Resource? (readonly)

Value of the resource field in the Inttegro API payload.

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

Returns:



49
50
51
52
53
54
55
 
# File 'lib/inttegro/upload_request/page_request.rb', line 49

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

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



49
50
51
52
53
54
55
 
# File 'lib/inttegro/upload_request/page_request.rb', line 49

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