Class: Inttegro::FileLink::CreateRequest

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

#access ⇒ Inttegro::FileLink::AccessRequest? (readonly)

Value of the access field in the Inttegro API payload.

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

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/file_link/create_request.rb', line 58

class CreateRequest < T::Struct
  const :file_id, String
  const :delivery, T.nilable(Inttegro::FileLink::Delivery), default: nil
  const :access, T.nilable(Inttegro::FileLink::AccessRequest), default: nil
  const :created_by, T.nilable(Inttegro::File::ActorInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end

#created_by ⇒ Inttegro::File::ActorInput? (readonly)

Value of the created_by field in the Inttegro API payload.

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

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/file_link/create_request.rb', line 58

class CreateRequest < T::Struct
  const :file_id, String
  const :delivery, T.nilable(Inttegro::FileLink::Delivery), default: nil
  const :access, T.nilable(Inttegro::FileLink::AccessRequest), default: nil
  const :created_by, T.nilable(Inttegro::File::ActorInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end

#custom_data ⇒ Inttegro::CustomData? (readonly)

Merchant-defined string values attached to a resource. SDKs expose this as a semantic collection rather than a raw map.

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

Returns:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/file_link/create_request.rb', line 58

class CreateRequest < T::Struct
  const :file_id, String
  const :delivery, T.nilable(Inttegro::FileLink::Delivery), default: nil
  const :access, T.nilable(Inttegro::FileLink::AccessRequest), default: nil
  const :created_by, T.nilable(Inttegro::File::ActorInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end

#delivery ⇒ Inttegro::FileLink::Delivery? (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:



58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/file_link/create_request.rb', line 58

class CreateRequest < T::Struct
  const :file_id, String
  const :delivery, T.nilable(Inttegro::FileLink::Delivery), default: nil
  const :access, T.nilable(Inttegro::FileLink::AccessRequest), default: nil
  const :created_by, T.nilable(Inttegro::File::ActorInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end

#expires_at ⇒ Time? (readonly)

Value of the expires_at field in the Inttegro API payload.

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

Returns:

  • (Time, nil) 


58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/file_link/create_request.rb', line 58

class CreateRequest < T::Struct
  const :file_id, String
  const :delivery, T.nilable(Inttegro::FileLink::Delivery), default: nil
  const :access, T.nilable(Inttegro::FileLink::AccessRequest), default: nil
  const :created_by, T.nilable(Inttegro::File::ActorInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), 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) 


58
59
60
61
62
63
64
65
 
# File 'lib/inttegro/file_link/create_request.rb', line 58

class CreateRequest < T::Struct
  const :file_id, String
  const :delivery, T.nilable(Inttegro::FileLink::Delivery), default: nil
  const :access, T.nilable(Inttegro::FileLink::AccessRequest), default: nil
  const :created_by, T.nilable(Inttegro::File::ActorInput), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end