Skip to content

Commit 3150f04

Browse files
stainless-botRobertCraigie
authored andcommitted
feat(docs): improve doc comments
1 parent a0459e0 commit 3150f04

5 files changed

Lines changed: 20 additions & 20 deletions

File tree

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,14 +137,14 @@ constructor(
137137
fun end(end: OffsetDateTime) = apply { this.end = end }
138138

139139
/**
140-
* The unique identifier of the last item in the previous page. Used to retrieve the next
141-
* page.
140+
* A cursor representing an item's token after which a page of results should begin. Used to
141+
* retrieve the next page of results after this item.
142142
*/
143143
fun startingAfter(startingAfter: String) = apply { this.startingAfter = startingAfter }
144144

145145
/**
146-
* The unique identifier of the first item in the previous page. Used to retrieve the
147-
* previous page.
146+
* A cursor representing an item's token before which a page of results should end. Used to
147+
* retrieve the previous page of results before this item.
148148
*/
149149
fun endingBefore(endingBefore: String) = apply { this.endingBefore = endingBefore }
150150

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,14 +149,14 @@ constructor(
149149
fun end(end: OffsetDateTime) = apply { this.end = end }
150150

151151
/**
152-
* The unique identifier of the last item in the previous page. Used to retrieve the next
153-
* page.
152+
* A cursor representing an item's token after which a page of results should begin. Used to
153+
* retrieve the next page of results after this item.
154154
*/
155155
fun startingAfter(startingAfter: String) = apply { this.startingAfter = startingAfter }
156156

157157
/**
158-
* The unique identifier of the first item in the previous page. Used to retrieve the
159-
* previous page.
158+
* A cursor representing an item's token before which a page of results should end. Used to
159+
* retrieve the previous page of results before this item.
160160
*/
161161
fun endingBefore(endingBefore: String) = apply { this.endingBefore = endingBefore }
162162

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,14 +135,14 @@ constructor(
135135
fun pageSize(pageSize: Long) = apply { this.pageSize = pageSize }
136136

137137
/**
138-
* The unique identifier of the last item in the previous page. Used to retrieve the next
139-
* page.
138+
* A cursor representing an item's token after which a page of results should begin. Used to
139+
* retrieve the next page of results after this item.
140140
*/
141141
fun startingAfter(startingAfter: String) = apply { this.startingAfter = startingAfter }
142142

143143
/**
144-
* The unique identifier of the first item in the previous page. Used to retrieve the
145-
* previous page.
144+
* A cursor representing an item's token before which a page of results should end. Used to
145+
* retrieve the previous page of results before this item.
146146
*/
147147
fun endingBefore(endingBefore: String) = apply { this.endingBefore = endingBefore }
148148

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,14 @@ constructor(
9292
fun pageSize(pageSize: Long) = apply { this.pageSize = pageSize }
9393

9494
/**
95-
* The unique identifier of the last item in the previous page. Used to retrieve the next
96-
* page.
95+
* A cursor representing an item's token after which a page of results should begin. Used to
96+
* retrieve the next page of results after this item.
9797
*/
9898
fun startingAfter(startingAfter: String) = apply { this.startingAfter = startingAfter }
9999

100100
/**
101-
* The unique identifier of the first item in the previous page. Used to retrieve the
102-
* previous page.
101+
* A cursor representing an item's token before which a page of results should end. Used to
102+
* retrieve the previous page of results before this item.
103103
*/
104104
fun endingBefore(endingBefore: String) = apply { this.endingBefore = endingBefore }
105105

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,14 +165,14 @@ constructor(
165165
fun end(end: OffsetDateTime) = apply { this.end = end }
166166

167167
/**
168-
* The unique identifier of the last item in the previous page. Used to retrieve the next
169-
* page.
168+
* A cursor representing an item's token after which a page of results should begin. Used to
169+
* retrieve the next page of results after this item.
170170
*/
171171
fun startingAfter(startingAfter: String) = apply { this.startingAfter = startingAfter }
172172

173173
/**
174-
* The unique identifier of the first item in the previous page. Used to retrieve the
175-
* previous page.
174+
* A cursor representing an item's token before which a page of results should end. Used to
175+
* retrieve the previous page of results before this item.
176176
*/
177177
fun endingBefore(endingBefore: String) = apply { this.endingBefore = endingBefore }
178178

0 commit comments

Comments
 (0)