Skip to content

Commit 440de6d

Browse files
stainless-app[bot]stainless-bot
authored andcommitted
docs: add some missing javadocs (#428)
1 parent c37cbfc commit 440de6d

File tree

10 files changed

+202
-37
lines changed

10 files changed

+202
-37
lines changed

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

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,7 @@ constructor(
492492
)
493493
}
494494

495+
/** Parameters for the current version of the Auth Rule */
495496
@JsonDeserialize(using = Parameters.Deserializer::class)
496497
@JsonSerialize(using = Parameters.Serializer::class)
497498
class Parameters
@@ -1050,6 +1051,7 @@ constructor(
10501051
override fun toString() = value.toString()
10511052
}
10521053

1054+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
10531055
@JsonDeserialize(using = Value.Deserializer::class)
10541056
@JsonSerialize(using = Value.Serializer::class)
10551057
class Value
@@ -1073,10 +1075,11 @@ constructor(
10731075

10741076
fun isStrings(): Boolean = strings != null
10751077

1078+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
10761079
fun asString(): String = string.getOrThrow("string")
1077-
1080+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
10781081
fun asInteger(): Long = integer.getOrThrow("integer")
1079-
1082+
/** An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` */
10801083
fun asStrings(): List<String> = strings.getOrThrow("strings")
10811084

10821085
fun _json(): Optional<JsonValue> = Optional.ofNullable(_json)
@@ -1111,10 +1114,15 @@ constructor(
11111114

11121115
companion object {
11131116

1117+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
11141118
@JvmStatic fun ofString(string: String) = Value(string = string)
11151119

1120+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
11161121
@JvmStatic fun ofInteger(integer: Long) = Value(integer = integer)
11171122

1123+
/**
1124+
* An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF`
1125+
*/
11181126
@JvmStatic
11191127
fun ofStrings(strings: List<String>) = Value(strings = strings)
11201128
}
@@ -1395,6 +1403,7 @@ constructor(
13951403
)
13961404
}
13971405

1406+
/** Parameters for the current version of the Auth Rule */
13981407
@JsonDeserialize(using = Parameters.Deserializer::class)
13991408
@JsonSerialize(using = Parameters.Serializer::class)
14001409
class Parameters
@@ -1953,6 +1962,7 @@ constructor(
19531962
override fun toString() = value.toString()
19541963
}
19551964

1965+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
19561966
@JsonDeserialize(using = Value.Deserializer::class)
19571967
@JsonSerialize(using = Value.Serializer::class)
19581968
class Value
@@ -1976,10 +1986,11 @@ constructor(
19761986

19771987
fun isStrings(): Boolean = strings != null
19781988

1989+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
19791990
fun asString(): String = string.getOrThrow("string")
1980-
1991+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
19811992
fun asInteger(): Long = integer.getOrThrow("integer")
1982-
1993+
/** An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` */
19831994
fun asStrings(): List<String> = strings.getOrThrow("strings")
19841995

19851996
fun _json(): Optional<JsonValue> = Optional.ofNullable(_json)
@@ -2014,10 +2025,15 @@ constructor(
20142025

20152026
companion object {
20162027

2028+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
20172029
@JvmStatic fun ofString(string: String) = Value(string = string)
20182030

2031+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
20192032
@JvmStatic fun ofInteger(integer: Long) = Value(integer = integer)
20202033

2034+
/**
2035+
* An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF`
2036+
*/
20212037
@JvmStatic
20222038
fun ofStrings(strings: List<String>) = Value(strings = strings)
20232039
}
@@ -2311,6 +2327,7 @@ constructor(
23112327
)
23122328
}
23132329

2330+
/** Parameters for the current version of the Auth Rule */
23142331
@JsonDeserialize(using = Parameters.Deserializer::class)
23152332
@JsonSerialize(using = Parameters.Serializer::class)
23162333
class Parameters
@@ -2869,6 +2886,7 @@ constructor(
28692886
override fun toString() = value.toString()
28702887
}
28712888

2889+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
28722890
@JsonDeserialize(using = Value.Deserializer::class)
28732891
@JsonSerialize(using = Value.Serializer::class)
28742892
class Value
@@ -2892,10 +2910,11 @@ constructor(
28922910

28932911
fun isStrings(): Boolean = strings != null
28942912

2913+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
28952914
fun asString(): String = string.getOrThrow("string")
2896-
2915+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
28972916
fun asInteger(): Long = integer.getOrThrow("integer")
2898-
2917+
/** An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` */
28992918
fun asStrings(): List<String> = strings.getOrThrow("strings")
29002919

29012920
fun _json(): Optional<JsonValue> = Optional.ofNullable(_json)
@@ -2930,10 +2949,15 @@ constructor(
29302949

29312950
companion object {
29322951

2952+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
29332953
@JvmStatic fun ofString(string: String) = Value(string = string)
29342954

2955+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
29352956
@JvmStatic fun ofInteger(integer: Long) = Value(integer = integer)
29362957

2958+
/**
2959+
* An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF`
2960+
*/
29372961
@JvmStatic
29382962
fun ofStrings(strings: List<String>) = Value(strings = strings)
29392963
}

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,7 @@ constructor(
312312
)
313313
}
314314

315+
/** Parameters for the current version of the Auth Rule */
315316
@JsonDeserialize(using = Parameters.Deserializer::class)
316317
@JsonSerialize(using = Parameters.Serializer::class)
317318
class Parameters
@@ -862,6 +863,7 @@ constructor(
862863
override fun toString() = value.toString()
863864
}
864865

866+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
865867
@JsonDeserialize(using = Value.Deserializer::class)
866868
@JsonSerialize(using = Value.Serializer::class)
867869
class Value
@@ -885,10 +887,11 @@ constructor(
885887

886888
fun isStrings(): Boolean = strings != null
887889

890+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
888891
fun asString(): String = string.getOrThrow("string")
889-
892+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
890893
fun asInteger(): Long = integer.getOrThrow("integer")
891-
894+
/** An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` */
892895
fun asStrings(): List<String> = strings.getOrThrow("strings")
893896

894897
fun _json(): Optional<JsonValue> = Optional.ofNullable(_json)
@@ -923,10 +926,13 @@ constructor(
923926

924927
companion object {
925928

929+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
926930
@JvmStatic fun ofString(string: String) = Value(string = string)
927931

932+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
928933
@JvmStatic fun ofInteger(integer: Long) = Value(integer = integer)
929934

935+
/** An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` */
930936
@JvmStatic fun ofStrings(strings: List<String>) = Value(strings = strings)
931937
}
932938

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

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,7 @@ private constructor(
388388
)
389389
}
390390

391+
/** Parameters for the current version of the Auth Rule */
391392
@JsonDeserialize(using = Parameters.Deserializer::class)
392393
@JsonSerialize(using = Parameters.Serializer::class)
393394
class Parameters
@@ -1073,6 +1074,7 @@ private constructor(
10731074
override fun toString() = value.toString()
10741075
}
10751076

1077+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
10761078
@JsonDeserialize(using = Value.Deserializer::class)
10771079
@JsonSerialize(using = Value.Serializer::class)
10781080
class Value
@@ -1098,10 +1100,11 @@ private constructor(
10981100

10991101
fun isStrings(): Boolean = strings != null
11001102

1103+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
11011104
fun asString(): String = string.getOrThrow("string")
1102-
1105+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
11031106
fun asInteger(): Long = integer.getOrThrow("integer")
1104-
1107+
/** An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` */
11051108
fun asStrings(): List<String> = strings.getOrThrow("strings")
11061109

11071110
fun _json(): Optional<JsonValue> = Optional.ofNullable(_json)
@@ -1145,10 +1148,15 @@ private constructor(
11451148

11461149
companion object {
11471150

1151+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
11481152
@JvmStatic fun ofString(string: String) = Value(string = string)
11491153

1154+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
11501155
@JvmStatic fun ofInteger(integer: Long) = Value(integer = integer)
11511156

1157+
/**
1158+
* An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF`
1159+
*/
11521160
@JvmStatic
11531161
fun ofStrings(strings: List<String>) = Value(strings = strings)
11541162
}
@@ -1363,6 +1371,7 @@ private constructor(
13631371
)
13641372
}
13651373

1374+
/** Parameters for the current version of the Auth Rule */
13661375
@JsonDeserialize(using = Parameters.Deserializer::class)
13671376
@JsonSerialize(using = Parameters.Serializer::class)
13681377
class Parameters
@@ -2048,6 +2057,7 @@ private constructor(
20482057
override fun toString() = value.toString()
20492058
}
20502059

2060+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
20512061
@JsonDeserialize(using = Value.Deserializer::class)
20522062
@JsonSerialize(using = Value.Serializer::class)
20532063
class Value
@@ -2073,10 +2083,11 @@ private constructor(
20732083

20742084
fun isStrings(): Boolean = strings != null
20752085

2086+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
20762087
fun asString(): String = string.getOrThrow("string")
2077-
2088+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
20782089
fun asInteger(): Long = integer.getOrThrow("integer")
2079-
2090+
/** An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` */
20802091
fun asStrings(): List<String> = strings.getOrThrow("strings")
20812092

20822093
fun _json(): Optional<JsonValue> = Optional.ofNullable(_json)
@@ -2120,10 +2131,15 @@ private constructor(
21202131

21212132
companion object {
21222133

2134+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
21232135
@JvmStatic fun ofString(string: String) = Value(string = string)
21242136

2137+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
21252138
@JvmStatic fun ofInteger(integer: Long) = Value(integer = integer)
21262139

2140+
/**
2141+
* An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF`
2142+
*/
21272143
@JvmStatic
21282144
fun ofStrings(strings: List<String>) = Value(strings = strings)
21292145
}

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

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,7 @@ private constructor(
388388
)
389389
}
390390

391+
/** Parameters for the current version of the Auth Rule */
391392
@JsonDeserialize(using = Parameters.Deserializer::class)
392393
@JsonSerialize(using = Parameters.Serializer::class)
393394
class Parameters
@@ -1073,6 +1074,7 @@ private constructor(
10731074
override fun toString() = value.toString()
10741075
}
10751076

1077+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
10761078
@JsonDeserialize(using = Value.Deserializer::class)
10771079
@JsonSerialize(using = Value.Serializer::class)
10781080
class Value
@@ -1098,10 +1100,11 @@ private constructor(
10981100

10991101
fun isStrings(): Boolean = strings != null
11001102

1103+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
11011104
fun asString(): String = string.getOrThrow("string")
1102-
1105+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
11031106
fun asInteger(): Long = integer.getOrThrow("integer")
1104-
1107+
/** An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` */
11051108
fun asStrings(): List<String> = strings.getOrThrow("strings")
11061109

11071110
fun _json(): Optional<JsonValue> = Optional.ofNullable(_json)
@@ -1145,10 +1148,15 @@ private constructor(
11451148

11461149
companion object {
11471150

1151+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
11481152
@JvmStatic fun ofString(string: String) = Value(string = string)
11491153

1154+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
11501155
@JvmStatic fun ofInteger(integer: Long) = Value(integer = integer)
11511156

1157+
/**
1158+
* An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF`
1159+
*/
11521160
@JvmStatic
11531161
fun ofStrings(strings: List<String>) = Value(strings = strings)
11541162
}
@@ -1363,6 +1371,7 @@ private constructor(
13631371
)
13641372
}
13651373

1374+
/** Parameters for the current version of the Auth Rule */
13661375
@JsonDeserialize(using = Parameters.Deserializer::class)
13671376
@JsonSerialize(using = Parameters.Serializer::class)
13681377
class Parameters
@@ -2048,6 +2057,7 @@ private constructor(
20482057
override fun toString() = value.toString()
20492058
}
20502059

2060+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
20512061
@JsonDeserialize(using = Value.Deserializer::class)
20522062
@JsonSerialize(using = Value.Serializer::class)
20532063
class Value
@@ -2073,10 +2083,11 @@ private constructor(
20732083

20742084
fun isStrings(): Boolean = strings != null
20752085

2086+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
20762087
fun asString(): String = string.getOrThrow("string")
2077-
2088+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
20782089
fun asInteger(): Long = integer.getOrThrow("integer")
2079-
2090+
/** An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` */
20802091
fun asStrings(): List<String> = strings.getOrThrow("strings")
20812092

20822093
fun _json(): Optional<JsonValue> = Optional.ofNullable(_json)
@@ -2120,10 +2131,15 @@ private constructor(
21202131

21212132
companion object {
21222133

2134+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
21232135
@JvmStatic fun ofString(string: String) = Value(string = string)
21242136

2137+
/** A number, to be used with `IS_GREATER_THAN` or `IS_LESS_THAN` */
21252138
@JvmStatic fun ofInteger(integer: Long) = Value(integer = integer)
21262139

2140+
/**
2141+
* An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF`
2142+
*/
21272143
@JvmStatic
21282144
fun ofStrings(strings: List<String>) = Value(strings = strings)
21292145
}

0 commit comments

Comments
 (0)