Class: Inttegro::File::CreateRequest

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

Overview

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

#custom_data ⇒ String? (readonly)

JSON object encoded as a string. Values must be strings.

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

Returns:

  • (String, nil) 


41
42
43
44
45
46
 
# File 'lib/inttegro/file/create_request.rb', line 41

class CreateRequest < T::Struct
  const :file, String
  const :purpose, String
  const :title, T.nilable(String), default: nil
  const :custom_data, T.nilable(String), default: nil
end

#file ⇒ String (readonly)

Binary file part to store.

Required in the API payload. Wire name: file.

Returns:

  • (String) 


41
42
43
44
45
46
 
# File 'lib/inttegro/file/create_request.rb', line 41

class CreateRequest < T::Struct
  const :file, String
  const :purpose, String
  const :title, T.nilable(String), default: nil
  const :custom_data, T.nilable(String), default: nil
end

#purpose ⇒ String (readonly)

File purpose policy to apply.

Required in the API payload. Wire name: purpose.

Returns:

  • (String) 


41
42
43
44
45
46
 
# File 'lib/inttegro/file/create_request.rb', line 41

class CreateRequest < T::Struct
  const :file, String
  const :purpose, String
  const :title, T.nilable(String), default: nil
  const :custom_data, T.nilable(String), default: nil
end

#title ⇒ String? (readonly)

Optional display title for the file.

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

Returns:

  • (String, nil) 


41
42
43
44
45
46
 
# File 'lib/inttegro/file/create_request.rb', line 41

class CreateRequest < T::Struct
  const :file, String
  const :purpose, String
  const :title, T.nilable(String), default: nil
  const :custom_data, T.nilable(String), default: nil
end