Skip to content

Commit adf74fb

Browse files
committed
docs(api): clarify dispute evidence filename docstring (#7)
1 parent 80f2d5c commit adf74fb

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

lithic-java-core/src/main/kotlin/com/lithic/api/models/DisputeEvidence.kt

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ private constructor(
4545
fun downloadUrl(): Optional<String> =
4646
Optional.ofNullable(downloadUrl.getNullable("download_url"))
4747

48-
/** File name of evidence. */
48+
/**
49+
* File name of evidence. Recommended to give the dispute evidence a human-readable identifier.
50+
*/
4951
fun filename(): Optional<String> = Optional.ofNullable(filename.getNullable("filename"))
5052

5153
/** Globally unique identifier. */
@@ -74,7 +76,9 @@ private constructor(
7476
/** URL to download evidence. Only shown when `upload_status` is `UPLOADED`. */
7577
@JsonProperty("download_url") @ExcludeMissing fun _downloadUrl() = downloadUrl
7678

77-
/** File name of evidence. */
79+
/**
80+
* File name of evidence. Recommended to give the dispute evidence a human-readable identifier.
81+
*/
7882
@JsonProperty("filename") @ExcludeMissing fun _filename() = filename
7983

8084
/** Globally unique identifier. */
@@ -203,10 +207,16 @@ private constructor(
203207
@ExcludeMissing
204208
fun downloadUrl(downloadUrl: JsonField<String>) = apply { this.downloadUrl = downloadUrl }
205209

206-
/** File name of evidence. */
210+
/**
211+
* File name of evidence. Recommended to give the dispute evidence a human-readable
212+
* identifier.
213+
*/
207214
fun filename(filename: String) = filename(JsonField.of(filename))
208215

209-
/** File name of evidence. */
216+
/**
217+
* File name of evidence. Recommended to give the dispute evidence a human-readable
218+
* identifier.
219+
*/
210220
@JsonProperty("filename")
211221
@ExcludeMissing
212222
fun filename(filename: JsonField<String>) = apply { this.filename = filename }

0 commit comments

Comments
 (0)