Class: Inttegro::UploadRequest::Display

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/upload_request/display.rb

Overview

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

#description ⇒ String? (readonly)

Value of the description field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


35
36
37
38
39
 
# File 'lib/inttegro/upload_request/display.rb', line 35

class Display < T::Struct
  const :title, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :help_text, T.nilable(String), default: nil
end

#help_text ⇒ String? (readonly)

Value of the help_text field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


35
36
37
38
39
 
# File 'lib/inttegro/upload_request/display.rb', line 35

class Display < T::Struct
  const :title, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :help_text, T.nilable(String), default: nil
end

#title ⇒ String? (readonly)

Value of the title field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


35
36
37
38
39
 
# File 'lib/inttegro/upload_request/display.rb', line 35

class Display < T::Struct
  const :title, T.nilable(String), default: nil
  const :description, T.nilable(String), default: nil
  const :help_text, T.nilable(String), default: nil
end