CustomerFileResponse class
Response from a POST /customer/files request or part of GET /customer/files response.
Contains metadata about an uploaded file including its unique identifier which can be used in subsequent PUT /customer requests.
Constructors
- CustomerFileResponse(String fileId, String contentType, int size, String? expiresAt, String? customerId)
- Creates a CustomerFileResponse from file metadata.
-
CustomerFileResponse.fromJson(Map<
String, dynamic> json) -
Creates a CustomerFileResponse from JSON response data.
factory
Properties
- contentType ↔ String
-
MIME type of the uploaded file.
Common values: 'image/jpeg', 'image/png', 'application/pdf', etc.
getter/setter pair
- customerId ↔ String?
-
(optional) The customer ID this file is associated with, if any.
getter/setter pair
- expiresAt ↔ String?
-
(optional) ISO 8601 timestamp indicating when the file will expire and need to be re-uploaded.
Example: '2024-12-31T23:59:59Z'
getter/setter pair
- fileId ↔ String
-
Unique identifier for the uploaded file.
Use this ID with the pattern '{field_name}_file_id' in PUT /customer requests.
For example, if uploading a photo ID front, use 'photo_id_front_file_id': '{this.fileId}'.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- rateLimitLimit ↔ int?
-
Maximum number of requests allowed in the current rate limit window.
getter/setter pairinherited
- rateLimitRemaining ↔ int?
-
Number of requests remaining in the current rate limit window.
getter/setter pairinherited
- rateLimitReset ↔ int?
-
Unix timestamp when the rate limit window will reset.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- size ↔ int
-
Size of the uploaded file in bytes.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setHeaders(
Map< String, String> headers) → void -
Populates rate limit fields from HTTP response headers.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited