Class: Inttegro::UploadRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/upload_request/upload_request.rb,
lib/inttegro/upload_request/base.rb,
lib/inttegro/upload_request/page.rb,
lib/inttegro/upload_request/actor.rb,
lib/inttegro/upload_request/review.rb,
lib/inttegro/upload_request/status.rb,
lib/inttegro/upload_request/attempt.rb,
lib/inttegro/upload_request/details.rb,
lib/inttegro/upload_request/display.rb,
lib/inttegro/upload_request/attempts.rb,
lib/inttegro/upload_request/response.rb,
lib/inttegro/upload_request/constraints.rb,
lib/inttegro/upload_request/latest_error.rb,
lib/inttegro/upload_request/page_request.rb,
lib/inttegro/upload_request/page_response.rb,
lib/inttegro/upload_request/review_reason.rb,
lib/inttegro/upload_request/cancel_request.rb,
lib/inttegro/upload_request/create_request.rb,
lib/inttegro/upload_request/lookup_request.rb,
lib/inttegro/upload_request/fulfill_request.rb,
lib/inttegro/upload_request/attempts_request.rb,
lib/inttegro/upload_request/validation_failure.rb,
lib/inttegro/upload_request/review_reason_input.rb,
lib/inttegro/upload_request/with_attempt_response.rb,
lib/inttegro/upload_request/review_attempt_request.rb,
lib/inttegro/upload_request/validation_failure_error.rb,
lib/inttegro/upload_request/review_attempt_by_id_request.rb,
lib/inttegro/upload_request/review_attempt_by_ordinal_request.rb

Overview

Public upload request metadata. Token hashes are not exposed.

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.

Defined Under Namespace

Classes: Actor, Attempt, Attempts, AttemptsRequest, CancelRequest, Constraints, CreateRequest, Details, Display, FulfillRequest, LatestError, LookupRequest, Page, PageRequest, PageResponse, Response, Review, ReviewAttemptByIDRequest, ReviewAttemptByOrdinalRequest, ReviewReason, ReviewReasonInput, Status, ValidationFailure, ValidationFailureError, WithAttemptResponse

Constant Summary collapse

ReviewAttemptRequest =

Typed representation of the review attempt request object in the Inttegro API.

Returns:

T.type_alias { T.any(Inttegro::UploadRequest::ReviewAttemptByIDRequest, Inttegro::UploadRequest::ReviewAttemptByOrdinalRequest) }

Instance Attribute Summary collapse

Instance Attribute Details

#active ⇒ Boolean (readonly)

Value of the active field in the Inttegro API payload.

Required in the API payload. Wire name: active.

Returns:

  • (Boolean) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#attempts ⇒ Inttegro::UploadRequest::Attempts (readonly)

Value of the attempts field in the Inttegro API payload.

Required in the API payload. Wire name: attempts.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#canceled_at ⇒ Time? (readonly)

Value of the canceled_at field in the Inttegro API payload.

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

Returns:

  • (Time, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#canceled_by ⇒ Inttegro::UploadRequest::Actor? (readonly)

Value of the canceled_by field in the Inttegro API payload.

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

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

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

Value of the constraints field in the Inttegro API payload.

Required in the API payload. Wire name: constraints.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#created_at ⇒ Time (readonly)

Value of the created_at field in the Inttegro API payload.

Required in the API payload. Wire name: created_at.

Returns:

  • (Time) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_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:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

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

Value of the display field in the Inttegro API payload.

Required in the API payload. Wire name: display.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#expired_at ⇒ Time? (readonly)

Value of the expired_at field in the Inttegro API payload.

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

Returns:

  • (Time, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#expires_at ⇒ Time (readonly)

Value of the expires_at field in the Inttegro API payload.

Required in the API payload. Wire name: expires_at.

Returns:

  • (Time) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#file_id ⇒ String? (readonly)

Value of the file_id field in the Inttegro API payload.

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

Returns:

  • (String, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#fulfilled_at ⇒ Time? (readonly)

Value of the fulfilled_at field in the Inttegro API payload.

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

Returns:

  • (Time, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#id ⇒ String (readonly)

Value of the id field in the Inttegro API payload.

Required in the API payload. Wire name: id.

Returns:

  • (String) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#latest_error ⇒ Inttegro::UploadRequest::LatestError? (readonly)

Value of the latest_error field in the Inttegro API payload.

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

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#metadata ⇒ Hash{String => String}? (readonly)

System-managed string metadata attached to a file resource.

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

Returns:

  • (Hash{String => String}, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_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) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

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

Value of the recipient field in the Inttegro API payload.

Required in the API payload. Wire name: recipient.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#requester ⇒ Inttegro::UploadRequest::Actor (readonly)

Value of the requester field in the Inttegro API payload.

Required in the API payload. Wire name: requester.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

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

Value of the resource field in the Inttegro API payload.

Required in the API payload. Wire name: resource.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#status ⇒ Inttegro::UploadRequest::Status (readonly)

Value of the status field in the Inttegro API payload.

Required in the API payload. Wire name: status.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

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

Value of the subject field in the Inttegro API payload.

Required in the API payload. Wire name: subject.

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#updated_at ⇒ Time (readonly)

Value of the updated_at field in the Inttegro API payload.

Required in the API payload. Wire name: updated_at.

Returns:

  • (Time) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#upload_url ⇒ String? (readonly)

Public capability URL returned when available. Treat as bearer-secret material.

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

Returns:

  • (String, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end

#uploading_at ⇒ Time? (readonly)

Value of the uploading_at field in the Inttegro API payload.

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

Returns:

  • (Time, nil) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/inttegro/upload_request/upload_request.rb', line 170

class UploadRequest
  const :id, String
  const :purpose, String
  const :status, Inttegro::UploadRequest::Status
  const :active, T::Boolean
  const :file_id, T.nilable(String), default: nil
  const :upload_url, T.nilable(String), default: nil
  const :constraints, Inttegro::UploadRequest::Constraints
  const :display_data, Inttegro::UploadRequest::Display, name: "display"
  const :subject, Inttegro::File::Party
  const :recipient, Inttegro::File::Party
  const :resource, Inttegro::File::Resource
  const :requester, Inttegro::UploadRequest::Actor
  const :attempts, Inttegro::UploadRequest::Attempts
  const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
  const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
  const :custom_data, T.nilable(Inttegro::CustomData), default: nil
  const :metadata, T.nilable(T::Hash[String, String]), default: nil
  const :created_at, Time
  const :updated_at, Time
  const :expires_at, Time
  const :uploading_at, T.nilable(Time), default: nil
  const :fulfilled_at, T.nilable(Time), default: nil
  const :expired_at, T.nilable(Time), default: nil
  const :canceled_at, T.nilable(Time), default: nil
end