Class: Inttegro::FileReference::Input

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/file_reference/input.rb

Overview

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

#field ⇒ String (readonly)

Non-blank resource field after trimming.

Required in the API payload. Wire name: field.

Returns:

  • (String) 


47
48
49
50
51
52
53
 
# File 'lib/inttegro/file_reference/input.rb', line 47

class Input < T::Struct
  const :file_id, String
  const :field, String
  const :reference, T.nilable(String), default: nil
  const :reference_kind, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end

#file_id ⇒ String (readonly)

Non-blank file ID after trimming.

Required in the API payload. Wire name: file_id.

Returns:

  • (String) 


47
48
49
50
51
52
53
 
# File 'lib/inttegro/file_reference/input.rb', line 47

class Input < T::Struct
  const :file_id, String
  const :field, String
  const :reference, T.nilable(String), default: nil
  const :reference_kind, T.nilable(String), default: nil
  const :purpose, T.nilable(String), 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) 


47
48
49
50
51
52
53
 
# File 'lib/inttegro/file_reference/input.rb', line 47

class Input < T::Struct
  const :file_id, String
  const :field, String
  const :reference, T.nilable(String), default: nil
  const :reference_kind, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end

#reference ⇒ String? (readonly)

Caller-supplied file or file link reference.

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

Returns:

  • (String, nil) 


47
48
49
50
51
52
53
 
# File 'lib/inttegro/file_reference/input.rb', line 47

class Input < T::Struct
  const :file_id, String
  const :field, String
  const :reference, T.nilable(String), default: nil
  const :reference_kind, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end

#reference_kind ⇒ String? (readonly)

Caller-defined reference kind; file and file_link are recommended.

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

Returns:

  • (String, nil) 


47
48
49
50
51
52
53
 
# File 'lib/inttegro/file_reference/input.rb', line 47

class Input < T::Struct
  const :file_id, String
  const :field, String
  const :reference, T.nilable(String), default: nil
  const :reference_kind, T.nilable(String), default: nil
  const :purpose, T.nilable(String), default: nil
end