Skip to content

Commit c74b79d

Browse files
stainless-app[bot]stainless-app[bot]
committed
docs(api): add character limit to natureOfBusiness, allowlisting info to qrCodeUrl
1 parent dfd77c3 commit c74b79d

17 files changed

Lines changed: 103 additions & 12 deletions

‎.stats.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 190
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-7fb459122adaf544433c3d5acd17566e642289b3eccb7ee25d7b7ce418967e32.yml
3-
openapi_spec_hash: fe69fbb129fa5b7d7b1e71d4f2a908f1
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-17c04dd1b0508b380c21e3acc3d4cd1e86b590f81d14fa26d1973b236f660e38.yml
3+
openapi_spec_hash: f8ddee07358d2c938450a6889fbf7940
44
config_hash: 400b9afe0f7f7b7d96177d05950775f9

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@ private constructor(
562562

563563
/**
564564
* Short description of the company's line of business (i.e., what does the company
565-
* do?).
565+
* do?). Values longer than 255 characters will be truncated before KYB verification
566566
*
567567
* @throws LithicInvalidDataException if the JSON field has an unexpected type (e.g. if
568568
* the server responded with an unexpected value).
@@ -857,7 +857,7 @@ private constructor(
857857

858858
/**
859859
* Short description of the company's line of business (i.e., what does the company
860-
* do?).
860+
* do?). Values longer than 255 characters will be truncated before KYB verification
861861
*/
862862
fun natureOfBusiness(natureOfBusiness: String) =
863863
natureOfBusiness(JsonField.of(natureOfBusiness))

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -569,7 +569,7 @@ private constructor(
569569

570570
/**
571571
* Short description of the company's line of business (i.e., what does the company
572-
* do?).
572+
* do?). Values longer than 255 characters will be truncated before KYB verification
573573
*
574574
* @throws LithicInvalidDataException if the JSON field has an unexpected type (e.g. if
575575
* the server responded with an unexpected value).
@@ -815,7 +815,7 @@ private constructor(
815815

816816
/**
817817
* Short description of the company's line of business (i.e., what does the company
818-
* do?).
818+
* do?). Values longer than 255 characters will be truncated before KYB verification
819819
*/
820820
fun natureOfBusiness(natureOfBusiness: String) =
821821
natureOfBusiness(JsonField.of(natureOfBusiness))

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,7 @@ private constructor(
343343

344344
/**
345345
* Short description of the company's line of business (i.e., what does the company do?).
346+
* Values longer than 255 characters will be truncated before KYB verification
346347
*
347348
* @throws LithicInvalidDataException if the JSON field has an unexpected type (e.g. if the
348349
* server responded with an unexpected value).
@@ -539,7 +540,7 @@ private constructor(
539540

540541
/**
541542
* Short description of the company's line of business (i.e., what does the company
542-
* do?).
543+
* do?). Values longer than 255 characters will be truncated before KYB verification
543544
*/
544545
fun natureOfBusiness(natureOfBusiness: String) =
545546
natureOfBusiness(JsonField.of(natureOfBusiness))

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ private constructor(
2828
) : this(qrCodeUrl, mutableMapOf())
2929

3030
/**
31-
* QR code url to display on the card carrier
31+
* QR code URL to display on the card carrier. The `qr_code_url` field requires your domain to
32+
* be allowlisted by Lithic before use. Contact Support to configure your QR code domain
3233
*
3334
* @throws LithicInvalidDataException if the JSON field has an unexpected type (e.g. if the
3435
* server responded with an unexpected value).
@@ -72,7 +73,10 @@ private constructor(
7273
additionalProperties = carrier.additionalProperties.toMutableMap()
7374
}
7475

75-
/** QR code url to display on the card carrier */
76+
/**
77+
* QR code URL to display on the card carrier. The `qr_code_url` field requires your domain
78+
* to be allowlisted by Lithic before use. Contact Support to configure your QR code domain
79+
*/
7680
fun qrCodeUrl(qrCodeUrl: String) = qrCodeUrl(JsonField.of(qrCodeUrl))
7781

7882
/**

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,8 @@ private constructor(
114114
fun controlPerson(): KybIndividual = controlPerson.getRequired("control_person")
115115

116116
/**
117-
* Short description of the company's line of business (i.e., what does the company do?).
117+
* Short description of the company's line of business (i.e., what does the company do?). Values
118+
* longer than 255 characters will be truncated before KYB verification
118119
*
119120
* @throws LithicInvalidDataException if the JSON field has an unexpected type or is
120121
* unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -395,6 +396,7 @@ private constructor(
395396

396397
/**
397398
* Short description of the company's line of business (i.e., what does the company do?).
399+
* Values longer than 255 characters will be truncated before KYB verification
398400
*/
399401
fun natureOfBusiness(natureOfBusiness: String) =
400402
natureOfBusiness(JsonField.of(natureOfBusiness))

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2676,6 +2676,7 @@ private constructor(
26762676

26772677
/**
26782678
* Short description of the company's line of business (i.e., what does the company do?).
2679+
* Values longer than 255 characters will be truncated before KYB verification
26792680
*
26802681
* @throws LithicInvalidDataException if the JSON field has an unexpected type (e.g. if the
26812682
* server responded with an unexpected value).
@@ -2872,7 +2873,7 @@ private constructor(
28722873

28732874
/**
28742875
* Short description of the company's line of business (i.e., what does the company
2875-
* do?).
2876+
* do?). Values longer than 255 characters will be truncated before KYB verification
28762877
*/
28772878
fun natureOfBusiness(natureOfBusiness: String) =
28782879
natureOfBusiness(JsonField.of(natureOfBusiness))

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

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3011,6 +3011,7 @@ private constructor(
30113011
private val achHoldPeriod: JsonField<Long>,
30123012
private val addenda: JsonField<String>,
30133013
private val companyId: JsonField<String>,
3014+
private val overrideCompanyName: JsonField<String>,
30143015
private val receiptRoutingNumber: JsonField<String>,
30153016
private val retries: JsonField<Long>,
30163017
private val returnReasonCode: JsonField<String>,
@@ -3032,6 +3033,9 @@ private constructor(
30323033
@JsonProperty("company_id")
30333034
@ExcludeMissing
30343035
companyId: JsonField<String> = JsonMissing.of(),
3036+
@JsonProperty("override_company_name")
3037+
@ExcludeMissing
3038+
overrideCompanyName: JsonField<String> = JsonMissing.of(),
30353039
@JsonProperty("receipt_routing_number")
30363040
@ExcludeMissing
30373041
receiptRoutingNumber: JsonField<String> = JsonMissing.of(),
@@ -3049,6 +3053,7 @@ private constructor(
30493053
achHoldPeriod,
30503054
addenda,
30513055
companyId,
3056+
overrideCompanyName,
30523057
receiptRoutingNumber,
30533058
retries,
30543059
returnReasonCode,
@@ -3089,6 +3094,16 @@ private constructor(
30893094
*/
30903095
fun companyId(): Optional<String> = companyId.getOptional("company_id")
30913096

3097+
/**
3098+
* Value to override the configured company name with. Can only be used if allowed to
3099+
* override
3100+
*
3101+
* @throws LithicInvalidDataException if the JSON field has an unexpected type (e.g. if
3102+
* the server responded with an unexpected value).
3103+
*/
3104+
fun overrideCompanyName(): Optional<String> =
3105+
overrideCompanyName.getOptional("override_company_name")
3106+
30923107
/**
30933108
* Receipt routing number
30943109
*
@@ -3157,6 +3172,16 @@ private constructor(
31573172
@ExcludeMissing
31583173
fun _companyId(): JsonField<String> = companyId
31593174

3175+
/**
3176+
* Returns the raw JSON value of [overrideCompanyName].
3177+
*
3178+
* Unlike [overrideCompanyName], this method doesn't throw if the JSON field has an
3179+
* unexpected type.
3180+
*/
3181+
@JsonProperty("override_company_name")
3182+
@ExcludeMissing
3183+
fun _overrideCompanyName(): JsonField<String> = overrideCompanyName
3184+
31603185
/**
31613186
* Returns the raw JSON value of [receiptRoutingNumber].
31623187
*
@@ -3226,6 +3251,7 @@ private constructor(
32263251
private var achHoldPeriod: JsonField<Long> = JsonMissing.of()
32273252
private var addenda: JsonField<String> = JsonMissing.of()
32283253
private var companyId: JsonField<String> = JsonMissing.of()
3254+
private var overrideCompanyName: JsonField<String> = JsonMissing.of()
32293255
private var receiptRoutingNumber: JsonField<String> = JsonMissing.of()
32303256
private var retries: JsonField<Long> = JsonMissing.of()
32313257
private var returnReasonCode: JsonField<String> = JsonMissing.of()
@@ -3238,6 +3264,7 @@ private constructor(
32383264
achHoldPeriod = achMethodAttributes.achHoldPeriod
32393265
addenda = achMethodAttributes.addenda
32403266
companyId = achMethodAttributes.companyId
3267+
overrideCompanyName = achMethodAttributes.overrideCompanyName
32413268
receiptRoutingNumber = achMethodAttributes.receiptRoutingNumber
32423269
retries = achMethodAttributes.retries
32433270
returnReasonCode = achMethodAttributes.returnReasonCode
@@ -3313,6 +3340,31 @@ private constructor(
33133340
*/
33143341
fun companyId(companyId: JsonField<String>) = apply { this.companyId = companyId }
33153342

3343+
/**
3344+
* Value to override the configured company name with. Can only be used if allowed
3345+
* to override
3346+
*/
3347+
fun overrideCompanyName(overrideCompanyName: String?) =
3348+
overrideCompanyName(JsonField.ofNullable(overrideCompanyName))
3349+
3350+
/**
3351+
* Alias for calling [Builder.overrideCompanyName] with
3352+
* `overrideCompanyName.orElse(null)`.
3353+
*/
3354+
fun overrideCompanyName(overrideCompanyName: Optional<String>) =
3355+
overrideCompanyName(overrideCompanyName.getOrNull())
3356+
3357+
/**
3358+
* Sets [Builder.overrideCompanyName] to an arbitrary JSON value.
3359+
*
3360+
* You should usually call [Builder.overrideCompanyName] with a well-typed [String]
3361+
* value instead. This method is primarily for setting the field to an undocumented
3362+
* or not yet supported value.
3363+
*/
3364+
fun overrideCompanyName(overrideCompanyName: JsonField<String>) = apply {
3365+
this.overrideCompanyName = overrideCompanyName
3366+
}
3367+
33163368
/** Receipt routing number */
33173369
fun receiptRoutingNumber(receiptRoutingNumber: String?) =
33183370
receiptRoutingNumber(JsonField.ofNullable(receiptRoutingNumber))
@@ -3446,6 +3498,7 @@ private constructor(
34463498
achHoldPeriod,
34473499
addenda,
34483500
companyId,
3501+
overrideCompanyName,
34493502
receiptRoutingNumber,
34503503
retries,
34513504
returnReasonCode,
@@ -3465,6 +3518,7 @@ private constructor(
34653518
achHoldPeriod()
34663519
addenda()
34673520
companyId()
3521+
overrideCompanyName()
34683522
receiptRoutingNumber()
34693523
retries()
34703524
returnReasonCode()
@@ -3492,6 +3546,7 @@ private constructor(
34923546
(if (achHoldPeriod.asKnown().isPresent) 1 else 0) +
34933547
(if (addenda.asKnown().isPresent) 1 else 0) +
34943548
(if (companyId.asKnown().isPresent) 1 else 0) +
3549+
(if (overrideCompanyName.asKnown().isPresent) 1 else 0) +
34953550
(if (receiptRoutingNumber.asKnown().isPresent) 1 else 0) +
34963551
(if (retries.asKnown().isPresent) 1 else 0) +
34973552
(if (returnReasonCode.asKnown().isPresent) 1 else 0) +
@@ -3663,6 +3718,7 @@ private constructor(
36633718
achHoldPeriod == other.achHoldPeriod &&
36643719
addenda == other.addenda &&
36653720
companyId == other.companyId &&
3721+
overrideCompanyName == other.overrideCompanyName &&
36663722
receiptRoutingNumber == other.receiptRoutingNumber &&
36673723
retries == other.retries &&
36683724
returnReasonCode == other.returnReasonCode &&
@@ -3676,6 +3732,7 @@ private constructor(
36763732
achHoldPeriod,
36773733
addenda,
36783734
companyId,
3735+
overrideCompanyName,
36793736
receiptRoutingNumber,
36803737
retries,
36813738
returnReasonCode,
@@ -3687,7 +3744,7 @@ private constructor(
36873744
override fun hashCode(): Int = hashCode
36883745

36893746
override fun toString() =
3690-
"AchMethodAttributes{secCode=$secCode, achHoldPeriod=$achHoldPeriod, addenda=$addenda, companyId=$companyId, receiptRoutingNumber=$receiptRoutingNumber, retries=$retries, returnReasonCode=$returnReasonCode, traceNumbers=$traceNumbers, additionalProperties=$additionalProperties}"
3747+
"AchMethodAttributes{secCode=$secCode, achHoldPeriod=$achHoldPeriod, addenda=$addenda, companyId=$companyId, overrideCompanyName=$overrideCompanyName, receiptRoutingNumber=$receiptRoutingNumber, retries=$retries, returnReasonCode=$returnReasonCode, traceNumbers=$traceNumbers, additionalProperties=$additionalProperties}"
36913748
}
36923749

36933750
class WireMethodAttributes

‎lithic-java-core/src/test/kotlin/com/lithic/api/models/AccountActivityListResponseTest.kt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -768,6 +768,7 @@ internal class AccountActivityListResponseTest {
768768
.achHoldPeriod(1L)
769769
.addenda(null)
770770
.companyId("1111111111")
771+
.overrideCompanyName("override_company_name")
771772
.receiptRoutingNumber(null)
772773
.retries(0L)
773774
.returnReasonCode(null)
@@ -846,6 +847,7 @@ internal class AccountActivityListResponseTest {
846847
.achHoldPeriod(1L)
847848
.addenda(null)
848849
.companyId("1111111111")
850+
.overrideCompanyName("override_company_name")
849851
.receiptRoutingNumber(null)
850852
.retries(0L)
851853
.returnReasonCode(null)

‎lithic-java-core/src/test/kotlin/com/lithic/api/models/AccountActivityRetrieveTransactionResponseTest.kt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -797,6 +797,7 @@ internal class AccountActivityRetrieveTransactionResponseTest {
797797
.achHoldPeriod(1L)
798798
.addenda(null)
799799
.companyId("1111111111")
800+
.overrideCompanyName("override_company_name")
800801
.receiptRoutingNumber(null)
801802
.retries(0L)
802803
.returnReasonCode(null)
@@ -876,6 +877,7 @@ internal class AccountActivityRetrieveTransactionResponseTest {
876877
.achHoldPeriod(1L)
877878
.addenda(null)
878879
.companyId("1111111111")
880+
.overrideCompanyName("override_company_name")
879881
.receiptRoutingNumber(null)
880882
.retries(0L)
881883
.returnReasonCode(null)

0 commit comments

Comments
 (0)