Skip to content

Commit 0fb6269

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore(docs): set of improvements (#258)
1 parent d52ec9d commit 0fb6269

16 files changed

Lines changed: 61 additions & 67 deletions

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

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -214,11 +214,11 @@ private constructor(
214214

215215
private var hashCode: Int = 0
216216

217-
/** An optional customer identifier. */
217+
/** A customer identifier. */
218218
fun customerReferenceNumber(): Optional<String> =
219219
Optional.ofNullable(customerReferenceNumber.getNullable("customer_reference_number"))
220220

221-
/** An optional merchant identifier. */
221+
/** A merchant identifier. */
222222
fun merchantReferenceNumber(): Optional<String> =
223223
Optional.ofNullable(merchantReferenceNumber.getNullable("merchant_reference_number"))
224224

@@ -230,12 +230,12 @@ private constructor(
230230

231231
fun lineItems(): List<LineItem> = lineItems.getRequired("line_items")
232232

233-
/** An optional customer identifier. */
233+
/** A customer identifier. */
234234
@JsonProperty("customer_reference_number")
235235
@ExcludeMissing
236236
fun _customerReferenceNumber() = customerReferenceNumber
237237

238-
/** An optional merchant identifier. */
238+
/** A merchant identifier. */
239239
@JsonProperty("merchant_reference_number")
240240
@ExcludeMissing
241241
fun _merchantReferenceNumber() = merchantReferenceNumber
@@ -320,22 +320,22 @@ private constructor(
320320
additionalProperties(commonData.additionalProperties)
321321
}
322322

323-
/** An optional customer identifier. */
323+
/** A customer identifier. */
324324
fun customerReferenceNumber(customerReferenceNumber: String) =
325325
customerReferenceNumber(JsonField.of(customerReferenceNumber))
326326

327-
/** An optional customer identifier. */
327+
/** A customer identifier. */
328328
@JsonProperty("customer_reference_number")
329329
@ExcludeMissing
330330
fun customerReferenceNumber(customerReferenceNumber: JsonField<String>) = apply {
331331
this.customerReferenceNumber = customerReferenceNumber
332332
}
333333

334-
/** An optional merchant identifier. */
334+
/** A merchant identifier. */
335335
fun merchantReferenceNumber(merchantReferenceNumber: String) =
336336
merchantReferenceNumber(JsonField.of(merchantReferenceNumber))
337337

338-
/** An optional merchant identifier. */
338+
/** A merchant identifier. */
339339
@JsonProperty("merchant_reference_number")
340340
@ExcludeMissing
341341
fun merchantReferenceNumber(merchantReferenceNumber: JsonField<String>) = apply {
@@ -797,18 +797,18 @@ private constructor(
797797
fun serviceType(): Optional<ServiceType> =
798798
Optional.ofNullable(serviceType.getNullable("service_type"))
799799

800-
/** The odometer reading entered into at the terminal at the time of sale. */
800+
/** The odometer reading entered into the terminal at the time of sale. */
801801
fun odometer(): Optional<Long> = Optional.ofNullable(odometer.getNullable("odometer"))
802802

803803
/**
804-
* The vehicle number entered into at the terminal at the time of sale, with leading zeroes
804+
* The vehicle number entered into the terminal at the time of sale, with leading zeros
805805
* stripped.
806806
*/
807807
fun vehicleNumber(): Optional<String> =
808808
Optional.ofNullable(vehicleNumber.getNullable("vehicle_number"))
809809

810810
/**
811-
* The driver number entered into at the terminal at the time of sale, with leading zeroes
811+
* The driver number entered into the terminal at the time of sale, with leading zeros
812812
* stripped.
813813
*/
814814
fun driverNumber(): Optional<String> =
@@ -821,17 +821,17 @@ private constructor(
821821
/** The type of fuel service. */
822822
@JsonProperty("service_type") @ExcludeMissing fun _serviceType() = serviceType
823823

824-
/** The odometer reading entered into at the terminal at the time of sale. */
824+
/** The odometer reading entered into the terminal at the time of sale. */
825825
@JsonProperty("odometer") @ExcludeMissing fun _odometer() = odometer
826826

827827
/**
828-
* The vehicle number entered into at the terminal at the time of sale, with leading zeroes
828+
* The vehicle number entered into the terminal at the time of sale, with leading zeros
829829
* stripped.
830830
*/
831831
@JsonProperty("vehicle_number") @ExcludeMissing fun _vehicleNumber() = vehicleNumber
832832

833833
/**
834-
* The driver number entered into at the terminal at the time of sale, with leading zeroes
834+
* The driver number entered into the terminal at the time of sale, with leading zeros
835835
* stripped.
836836
*/
837837
@JsonProperty("driver_number") @ExcludeMissing fun _driverNumber() = driverNumber
@@ -928,23 +928,23 @@ private constructor(
928928
this.serviceType = serviceType
929929
}
930930

931-
/** The odometer reading entered into at the terminal at the time of sale. */
931+
/** The odometer reading entered into the terminal at the time of sale. */
932932
fun odometer(odometer: Long) = odometer(JsonField.of(odometer))
933933

934-
/** The odometer reading entered into at the terminal at the time of sale. */
934+
/** The odometer reading entered into the terminal at the time of sale. */
935935
@JsonProperty("odometer")
936936
@ExcludeMissing
937937
fun odometer(odometer: JsonField<Long>) = apply { this.odometer = odometer }
938938

939939
/**
940-
* The vehicle number entered into at the terminal at the time of sale, with leading
941-
* zeroes stripped.
940+
* The vehicle number entered into the terminal at the time of sale, with leading zeros
941+
* stripped.
942942
*/
943943
fun vehicleNumber(vehicleNumber: String) = vehicleNumber(JsonField.of(vehicleNumber))
944944

945945
/**
946-
* The vehicle number entered into at the terminal at the time of sale, with leading
947-
* zeroes stripped.
946+
* The vehicle number entered into the terminal at the time of sale, with leading zeros
947+
* stripped.
948948
*/
949949
@JsonProperty("vehicle_number")
950950
@ExcludeMissing
@@ -953,14 +953,14 @@ private constructor(
953953
}
954954

955955
/**
956-
* The driver number entered into at the terminal at the time of sale, with leading
957-
* zeroes stripped.
956+
* The driver number entered into the terminal at the time of sale, with leading zeros
957+
* stripped.
958958
*/
959959
fun driverNumber(driverNumber: String) = driverNumber(JsonField.of(driverNumber))
960960

961961
/**
962-
* The driver number entered into at the terminal at the time of sale, with leading
963-
* zeroes stripped.
962+
* The driver number entered into the terminal at the time of sale, with leading zeros
963+
* stripped.
964964
*/
965965
@JsonProperty("driver_number")
966966
@ExcludeMissing

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

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ private constructor(
3939
private val ytdTotals: JsonField<StatementTotals>,
4040
private val created: JsonField<OffsetDateTime>,
4141
private val updated: JsonField<OffsetDateTime>,
42-
private val nextStatementDate: JsonField<LocalDate>,
4342
private val creditProductToken: JsonField<String>,
4443
private val accountStanding: JsonField<AccountStanding>,
4544
private val additionalProperties: Map<String, JsonValue>,
@@ -106,9 +105,6 @@ private constructor(
106105
/** Timestamp of when the statement was updated */
107106
fun updated(): OffsetDateTime = updated.getRequired("updated")
108107

109-
/** Date of when the next statement will be created */
110-
fun nextStatementDate(): LocalDate = nextStatementDate.getRequired("next_statement_date")
111-
112108
/** Globally unique identifier for a credit product */
113109
fun creditProductToken(): String = creditProductToken.getRequired("credit_product_token")
114110

@@ -176,11 +172,6 @@ private constructor(
176172
/** Timestamp of when the statement was updated */
177173
@JsonProperty("updated") @ExcludeMissing fun _updated() = updated
178174

179-
/** Date of when the next statement will be created */
180-
@JsonProperty("next_statement_date")
181-
@ExcludeMissing
182-
fun _nextStatementDate() = nextStatementDate
183-
184175
/** Globally unique identifier for a credit product */
185176
@JsonProperty("credit_product_token")
186177
@ExcludeMissing
@@ -210,7 +201,6 @@ private constructor(
210201
ytdTotals().validate()
211202
created()
212203
updated()
213-
nextStatementDate()
214204
creditProductToken()
215205
accountStanding().validate()
216206
validated = true
@@ -241,7 +231,6 @@ private constructor(
241231
this.ytdTotals == other.ytdTotals &&
242232
this.created == other.created &&
243233
this.updated == other.updated &&
244-
this.nextStatementDate == other.nextStatementDate &&
245234
this.creditProductToken == other.creditProductToken &&
246235
this.accountStanding == other.accountStanding &&
247236
this.additionalProperties == other.additionalProperties
@@ -267,7 +256,6 @@ private constructor(
267256
ytdTotals,
268257
created,
269258
updated,
270-
nextStatementDate,
271259
creditProductToken,
272260
accountStanding,
273261
additionalProperties,
@@ -277,7 +265,7 @@ private constructor(
277265
}
278266

279267
override fun toString() =
280-
"Statement{token=$token, financialAccountToken=$financialAccountToken, statementStartDate=$statementStartDate, statementEndDate=$statementEndDate, paymentDueDate=$paymentDueDate, daysInBillingCycle=$daysInBillingCycle, creditLimit=$creditLimit, availableCredit=$availableCredit, startingBalance=$startingBalance, endingBalance=$endingBalance, amountDue=$amountDue, amountPastDue=$amountPastDue, periodTotals=$periodTotals, ytdTotals=$ytdTotals, created=$created, updated=$updated, nextStatementDate=$nextStatementDate, creditProductToken=$creditProductToken, accountStanding=$accountStanding, additionalProperties=$additionalProperties}"
268+
"Statement{token=$token, financialAccountToken=$financialAccountToken, statementStartDate=$statementStartDate, statementEndDate=$statementEndDate, paymentDueDate=$paymentDueDate, daysInBillingCycle=$daysInBillingCycle, creditLimit=$creditLimit, availableCredit=$availableCredit, startingBalance=$startingBalance, endingBalance=$endingBalance, amountDue=$amountDue, amountPastDue=$amountPastDue, periodTotals=$periodTotals, ytdTotals=$ytdTotals, created=$created, updated=$updated, creditProductToken=$creditProductToken, accountStanding=$accountStanding, additionalProperties=$additionalProperties}"
281269

282270
companion object {
283271

@@ -302,7 +290,6 @@ private constructor(
302290
private var ytdTotals: JsonField<StatementTotals> = JsonMissing.of()
303291
private var created: JsonField<OffsetDateTime> = JsonMissing.of()
304292
private var updated: JsonField<OffsetDateTime> = JsonMissing.of()
305-
private var nextStatementDate: JsonField<LocalDate> = JsonMissing.of()
306293
private var creditProductToken: JsonField<String> = JsonMissing.of()
307294
private var accountStanding: JsonField<AccountStanding> = JsonMissing.of()
308295
private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
@@ -325,7 +312,6 @@ private constructor(
325312
this.ytdTotals = statement.ytdTotals
326313
this.created = statement.created
327314
this.updated = statement.updated
328-
this.nextStatementDate = statement.nextStatementDate
329315
this.creditProductToken = statement.creditProductToken
330316
this.accountStanding = statement.accountStanding
331317
additionalProperties(statement.additionalProperties)
@@ -499,17 +485,6 @@ private constructor(
499485
@ExcludeMissing
500486
fun updated(updated: JsonField<OffsetDateTime>) = apply { this.updated = updated }
501487

502-
/** Date of when the next statement will be created */
503-
fun nextStatementDate(nextStatementDate: LocalDate) =
504-
nextStatementDate(JsonField.of(nextStatementDate))
505-
506-
/** Date of when the next statement will be created */
507-
@JsonProperty("next_statement_date")
508-
@ExcludeMissing
509-
fun nextStatementDate(nextStatementDate: JsonField<LocalDate>) = apply {
510-
this.nextStatementDate = nextStatementDate
511-
}
512-
513488
/** Globally unique identifier for a credit product */
514489
fun creditProductToken(creditProductToken: String) =
515490
creditProductToken(JsonField.of(creditProductToken))
@@ -562,7 +537,6 @@ private constructor(
562537
ytdTotals,
563538
created,
564539
updated,
565-
nextStatementDate,
566540
creditProductToken,
567541
accountStanding,
568542
additionalProperties.toUnmodifiable(),

‎lithic-java-core/src/main/kotlin/com/lithic/api/services/async/reports/SettlementServiceAsync.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ interface SettlementServiceAsync {
2020
requestOptions: RequestOptions = RequestOptions.none()
2121
): CompletableFuture<ReportSettlementListDetailsPageAsync>
2222

23-
/** Get the settlement report for a specified report date. */
23+
/** Get the settlement report for a specified report date. Not available in sandbox. */
2424
@JvmOverloads
2525
fun summary(
2626
params: ReportSettlementSummaryParams,

‎lithic-java-core/src/main/kotlin/com/lithic/api/services/async/reports/SettlementServiceAsyncImpl.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ constructor(
5858
private val summaryHandler: Handler<SettlementReport> =
5959
jsonHandler<SettlementReport>(clientOptions.jsonMapper).withErrorHandler(errorHandler)
6060

61-
/** Get the settlement report for a specified report date. */
61+
/** Get the settlement report for a specified report date. Not available in sandbox. */
6262
override fun summary(
6363
params: ReportSettlementSummaryParams,
6464
requestOptions: RequestOptions

‎lithic-java-core/src/main/kotlin/com/lithic/api/services/async/transactions/EnhancedCommercialDataServiceAsync.kt‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ import java.util.concurrent.CompletableFuture
1111

1212
interface EnhancedCommercialDataServiceAsync {
1313

14-
/** Get all L2/L3 enhanced commercial data associated with a transaction. */
14+
/**
15+
* Get all L2/L3 enhanced commercial data associated with a transaction. Not available in
16+
* sandbox.
17+
*/
1518
@JvmOverloads
1619
fun retrieve(
1720
params: TransactionEnhancedCommercialDataRetrieveParams,

‎lithic-java-core/src/main/kotlin/com/lithic/api/services/async/transactions/EnhancedCommercialDataServiceAsyncImpl.kt‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,10 @@ constructor(
2626
jsonHandler<EnhancedCommercialDataRetrieveResponse>(clientOptions.jsonMapper)
2727
.withErrorHandler(errorHandler)
2828

29-
/** Get all L2/L3 enhanced commercial data associated with a transaction. */
29+
/**
30+
* Get all L2/L3 enhanced commercial data associated with a transaction. Not available in
31+
* sandbox.
32+
*/
3033
override fun retrieve(
3134
params: TransactionEnhancedCommercialDataRetrieveParams,
3235
requestOptions: RequestOptions

‎lithic-java-core/src/main/kotlin/com/lithic/api/services/async/transactions/events/EnhancedCommercialDataServiceAsync.kt‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ import java.util.concurrent.CompletableFuture
1111

1212
interface EnhancedCommercialDataServiceAsync {
1313

14-
/** Get L2/L3 enhanced commercial data associated with a transaction event. */
14+
/**
15+
* Get L2/L3 enhanced commercial data associated with a transaction event. Not available in
16+
* sandbox.
17+
*/
1518
@JvmOverloads
1619
fun retrieve(
1720
params: TransactionEventEnhancedCommercialDataRetrieveParams,

‎lithic-java-core/src/main/kotlin/com/lithic/api/services/async/transactions/events/EnhancedCommercialDataServiceAsyncImpl.kt‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ constructor(
2525
private val retrieveHandler: Handler<EnhancedData> =
2626
jsonHandler<EnhancedData>(clientOptions.jsonMapper).withErrorHandler(errorHandler)
2727

28-
/** Get L2/L3 enhanced commercial data associated with a transaction event. */
28+
/**
29+
* Get L2/L3 enhanced commercial data associated with a transaction event. Not available in
30+
* sandbox.
31+
*/
2932
override fun retrieve(
3033
params: TransactionEventEnhancedCommercialDataRetrieveParams,
3134
requestOptions: RequestOptions

‎lithic-java-core/src/main/kotlin/com/lithic/api/services/blocking/reports/SettlementService.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ interface SettlementService {
1919
requestOptions: RequestOptions = RequestOptions.none()
2020
): ReportSettlementListDetailsPage
2121

22-
/** Get the settlement report for a specified report date. */
22+
/** Get the settlement report for a specified report date. Not available in sandbox. */
2323
@JvmOverloads
2424
fun summary(
2525
params: ReportSettlementSummaryParams,

‎lithic-java-core/src/main/kotlin/com/lithic/api/services/blocking/reports/SettlementServiceImpl.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ constructor(
5656
private val summaryHandler: Handler<SettlementReport> =
5757
jsonHandler<SettlementReport>(clientOptions.jsonMapper).withErrorHandler(errorHandler)
5858

59-
/** Get the settlement report for a specified report date. */
59+
/** Get the settlement report for a specified report date. Not available in sandbox. */
6060
override fun summary(
6161
params: ReportSettlementSummaryParams,
6262
requestOptions: RequestOptions

0 commit comments

Comments
 (0)