Class: Inttegro::File::ContentsRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/file/contents_request.rb

Overview

Typed representation of the contents 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

#delivery ⇒ Inttegro::File::ContentsDeliveryMode? (readonly)

Value of the delivery field in the Inttegro API payload.

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

Returns:



37
38
39
40
41
 
# File 'lib/inttegro/file/contents_request.rb', line 37

class ContentsRequest < T::Struct
  const :file_id, String
  const :disposition, T.nilable(Inttegro::File::Disposition), default: nil
  const :delivery, T.nilable(Inttegro::File::ContentsDeliveryMode), default: nil
end

#disposition ⇒ Inttegro::File::Disposition? (readonly)

Value of the disposition field in the Inttegro API payload.

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

Returns:



37
38
39
40
41
 
# File 'lib/inttegro/file/contents_request.rb', line 37

class ContentsRequest < T::Struct
  const :file_id, String
  const :disposition, T.nilable(Inttegro::File::Disposition), default: nil
  const :delivery, T.nilable(Inttegro::File::ContentsDeliveryMode), default: nil
end

#file_id ⇒ String (readonly)

Value of the file_id field in the Inttegro API payload.

Required in the API payload. Wire name: file_id.

Returns:

  • (String) 


37
38
39
40
41
 
# File 'lib/inttegro/file/contents_request.rb', line 37

class ContentsRequest < T::Struct
  const :file_id, String
  const :disposition, T.nilable(Inttegro::File::Disposition), default: nil
  const :delivery, T.nilable(Inttegro::File::ContentsDeliveryMode), default: nil
end