Class: Inttegro::UploadRequest::CreateRequest

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

#attempts ⇒ Inttegro::UploadRequest::AttemptsRequest? (readonly)

Value of the attempts field in the Inttegro API payload.

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

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/inttegro/upload_request/create_request.rb', line 85

class CreateRequest < T::Struct
  const :purpose, String
  const :constraints, T.nilable(Inttegro::UploadRequest::Constraints), default: nil
  const :display_data, T.nilable(Inttegro::UploadRequest::Display), default: nil, name: "display"
  const :subject, T.nilable(Inttegro::File::Party), default: nil
  const :recipient, T.nilable(Inttegro::File::Party), default: nil
  const :resource, T.nilable(Inttegro::File::Resource), default: nil
  const :requester, T.nilable(Inttegro::File::ActorInput), default: nil
  const :attempts, T.nilable(Inttegro::UploadRequest::AttemptsRequest), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end

#constraints ⇒ Inttegro::UploadRequest::Constraints? (readonly)

Value of the constraints field in the Inttegro API payload.

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

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/inttegro/upload_request/create_request.rb', line 85

class CreateRequest < T::Struct
  const :purpose, String
  const :constraints, T.nilable(Inttegro::UploadRequest::Constraints), default: nil
  const :display_data, T.nilable(Inttegro::UploadRequest::Display), default: nil, name: "display"
  const :subject, T.nilable(Inttegro::File::Party), default: nil
  const :recipient, T.nilable(Inttegro::File::Party), default: nil
  const :resource, T.nilable(Inttegro::File::Resource), default: nil
  const :requester, T.nilable(Inttegro::File::ActorInput), default: nil
  const :attempts, T.nilable(Inttegro::UploadRequest::AttemptsRequest), 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:



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/inttegro/upload_request/create_request.rb', line 85

class CreateRequest < T::Struct
  const :purpose, String
  const :constraints, T.nilable(Inttegro::UploadRequest::Constraints), default: nil
  const :display_data, T.nilable(Inttegro::UploadRequest::Display), default: nil, name: "display"
  const :subject, T.nilable(Inttegro::File::Party), default: nil
  const :recipient, T.nilable(Inttegro::File::Party), default: nil
  const :resource, T.nilable(Inttegro::File::Resource), default: nil
  const :requester, T.nilable(Inttegro::File::ActorInput), default: nil
  const :attempts, T.nilable(Inttegro::UploadRequest::AttemptsRequest), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end

#display_data ⇒ Inttegro::UploadRequest::Display? (readonly)

Value of the display field in the Inttegro API payload.

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

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/inttegro/upload_request/create_request.rb', line 85

class CreateRequest < T::Struct
  const :purpose, String
  const :constraints, T.nilable(Inttegro::UploadRequest::Constraints), default: nil
  const :display_data, T.nilable(Inttegro::UploadRequest::Display), default: nil, name: "display"
  const :subject, T.nilable(Inttegro::File::Party), default: nil
  const :recipient, T.nilable(Inttegro::File::Party), default: nil
  const :resource, T.nilable(Inttegro::File::Resource), default: nil
  const :requester, T.nilable(Inttegro::File::ActorInput), default: nil
  const :attempts, T.nilable(Inttegro::UploadRequest::AttemptsRequest), 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) 


85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/inttegro/upload_request/create_request.rb', line 85

class CreateRequest < T::Struct
  const :purpose, String
  const :constraints, T.nilable(Inttegro::UploadRequest::Constraints), default: nil
  const :display_data, T.nilable(Inttegro::UploadRequest::Display), default: nil, name: "display"
  const :subject, T.nilable(Inttegro::File::Party), default: nil
  const :recipient, T.nilable(Inttegro::File::Party), default: nil
  const :resource, T.nilable(Inttegro::File::Resource), default: nil
  const :requester, T.nilable(Inttegro::File::ActorInput), default: nil
  const :attempts, T.nilable(Inttegro::UploadRequest::AttemptsRequest), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end

#purpose ⇒ String (readonly)

Value of the purpose field in the Inttegro API payload.

Required in the API payload. Wire name: purpose.

Returns:

  • (String) 


85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/inttegro/upload_request/create_request.rb', line 85

class CreateRequest < T::Struct
  const :purpose, String
  const :constraints, T.nilable(Inttegro::UploadRequest::Constraints), default: nil
  const :display_data, T.nilable(Inttegro::UploadRequest::Display), default: nil, name: "display"
  const :subject, T.nilable(Inttegro::File::Party), default: nil
  const :recipient, T.nilable(Inttegro::File::Party), default: nil
  const :resource, T.nilable(Inttegro::File::Resource), default: nil
  const :requester, T.nilable(Inttegro::File::ActorInput), default: nil
  const :attempts, T.nilable(Inttegro::UploadRequest::AttemptsRequest), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end

#recipient ⇒ Inttegro::File::Party? (readonly)

Value of the recipient field in the Inttegro API payload.

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

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/inttegro/upload_request/create_request.rb', line 85

class CreateRequest < T::Struct
  const :purpose, String
  const :constraints, T.nilable(Inttegro::UploadRequest::Constraints), default: nil
  const :display_data, T.nilable(Inttegro::UploadRequest::Display), default: nil, name: "display"
  const :subject, T.nilable(Inttegro::File::Party), default: nil
  const :recipient, T.nilable(Inttegro::File::Party), default: nil
  const :resource, T.nilable(Inttegro::File::Resource), default: nil
  const :requester, T.nilable(Inttegro::File::ActorInput), default: nil
  const :attempts, T.nilable(Inttegro::UploadRequest::AttemptsRequest), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end

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

Value of the requester field in the Inttegro API payload.

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

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/inttegro/upload_request/create_request.rb', line 85

class CreateRequest < T::Struct
  const :purpose, String
  const :constraints, T.nilable(Inttegro::UploadRequest::Constraints), default: nil
  const :display_data, T.nilable(Inttegro::UploadRequest::Display), default: nil, name: "display"
  const :subject, T.nilable(Inttegro::File::Party), default: nil
  const :recipient, T.nilable(Inttegro::File::Party), default: nil
  const :resource, T.nilable(Inttegro::File::Resource), default: nil
  const :requester, T.nilable(Inttegro::File::ActorInput), default: nil
  const :attempts, T.nilable(Inttegro::UploadRequest::AttemptsRequest), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end

#resource ⇒ Inttegro::File::Resource? (readonly)

Value of the resource field in the Inttegro API payload.

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

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/inttegro/upload_request/create_request.rb', line 85

class CreateRequest < T::Struct
  const :purpose, String
  const :constraints, T.nilable(Inttegro::UploadRequest::Constraints), default: nil
  const :display_data, T.nilable(Inttegro::UploadRequest::Display), default: nil, name: "display"
  const :subject, T.nilable(Inttegro::File::Party), default: nil
  const :recipient, T.nilable(Inttegro::File::Party), default: nil
  const :resource, T.nilable(Inttegro::File::Resource), default: nil
  const :requester, T.nilable(Inttegro::File::ActorInput), default: nil
  const :attempts, T.nilable(Inttegro::UploadRequest::AttemptsRequest), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end

#subject ⇒ Inttegro::File::Party? (readonly)

Value of the subject field in the Inttegro API payload.

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

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/inttegro/upload_request/create_request.rb', line 85

class CreateRequest < T::Struct
  const :purpose, String
  const :constraints, T.nilable(Inttegro::UploadRequest::Constraints), default: nil
  const :display_data, T.nilable(Inttegro::UploadRequest::Display), default: nil, name: "display"
  const :subject, T.nilable(Inttegro::File::Party), default: nil
  const :recipient, T.nilable(Inttegro::File::Party), default: nil
  const :resource, T.nilable(Inttegro::File::Resource), default: nil
  const :requester, T.nilable(Inttegro::File::ActorInput), default: nil
  const :attempts, T.nilable(Inttegro::UploadRequest::AttemptsRequest), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :expires_at, T.nilable(Time), default: nil
end