Skip to content

Commit 91f1327

Browse files
docs: add docstrings (#366)
1 parent e5e0ccf commit 91f1327

10 files changed

Lines changed: 88 additions & 0 deletions

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -697,6 +697,7 @@ constructor(
697697
fun operation(): Optional<Operation> =
698698
Optional.ofNullable(operation.getNullable("operation"))
699699

700+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
700701
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
701702

702703
/**
@@ -736,6 +737,7 @@ constructor(
736737
/** The operation to apply to the attribute */
737738
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
738739

740+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
739741
@JsonProperty("value") @ExcludeMissing fun _value() = value
740742

741743
@JsonAnyGetter
@@ -858,8 +860,10 @@ constructor(
858860
this.operation = operation
859861
}
860862

863+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
861864
fun value(value: Value) = value(JsonField.of(value))
862865

866+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
863867
@JsonProperty("value")
864868
@ExcludeMissing
865869
fun value(value: JsonField<Value>) = apply { this.value = value }
@@ -1672,6 +1676,7 @@ constructor(
16721676
fun operation(): Optional<Operation> =
16731677
Optional.ofNullable(operation.getNullable("operation"))
16741678

1679+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
16751680
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
16761681

16771682
/**
@@ -1711,6 +1716,7 @@ constructor(
17111716
/** The operation to apply to the attribute */
17121717
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
17131718

1719+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
17141720
@JsonProperty("value") @ExcludeMissing fun _value() = value
17151721

17161722
@JsonAnyGetter
@@ -1833,8 +1839,10 @@ constructor(
18331839
this.operation = operation
18341840
}
18351841

1842+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
18361843
fun value(value: Value) = value(JsonField.of(value))
18371844

1845+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
18381846
@JsonProperty("value")
18391847
@ExcludeMissing
18401848
fun value(value: JsonField<Value>) = apply { this.value = value }
@@ -2647,6 +2655,7 @@ constructor(
26472655
fun operation(): Optional<Operation> =
26482656
Optional.ofNullable(operation.getNullable("operation"))
26492657

2658+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
26502659
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
26512660

26522661
/**
@@ -2686,6 +2695,7 @@ constructor(
26862695
/** The operation to apply to the attribute */
26872696
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
26882697

2698+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
26892699
@JsonProperty("value") @ExcludeMissing fun _value() = value
26902700

26912701
@JsonAnyGetter
@@ -2808,8 +2818,10 @@ constructor(
28082818
this.operation = operation
28092819
}
28102820

2821+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
28112822
fun value(value: Value) = value(JsonField.of(value))
28122823

2824+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
28132825
@JsonProperty("value")
28142826
@ExcludeMissing
28152827
fun value(value: JsonField<Value>) = apply { this.value = value }

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -515,6 +515,7 @@ constructor(
515515
fun operation(): Optional<Operation> =
516516
Optional.ofNullable(operation.getNullable("operation"))
517517

518+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
518519
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
519520

520521
/**
@@ -554,6 +555,7 @@ constructor(
554555
/** The operation to apply to the attribute */
555556
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
556557

558+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
557559
@JsonProperty("value") @ExcludeMissing fun _value() = value
558560

559561
@JsonAnyGetter
@@ -673,8 +675,10 @@ constructor(
673675
this.operation = operation
674676
}
675677

678+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
676679
fun value(value: Value) = value(JsonField.of(value))
677680

681+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
678682
@JsonProperty("value")
679683
@ExcludeMissing
680684
fun value(value: JsonField<Value>) = apply { this.value = value }

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,6 +594,7 @@ private constructor(
594594
fun operation(): Optional<Operation> =
595595
Optional.ofNullable(operation.getNullable("operation"))
596596

597+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
597598
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
598599

599600
/**
@@ -633,6 +634,7 @@ private constructor(
633634
/** The operation to apply to the attribute */
634635
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
635636

637+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
636638
@JsonProperty("value") @ExcludeMissing fun _value() = value
637639

638640
@JsonAnyGetter
@@ -755,8 +757,10 @@ private constructor(
755757
this.operation = operation
756758
}
757759

760+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
758761
fun value(value: Value) = value(JsonField.of(value))
759762

763+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
760764
@JsonProperty("value")
761765
@ExcludeMissing
762766
fun value(value: JsonField<Value>) = apply { this.value = value }
@@ -1530,6 +1534,7 @@ private constructor(
15301534
fun operation(): Optional<Operation> =
15311535
Optional.ofNullable(operation.getNullable("operation"))
15321536

1537+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
15331538
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
15341539

15351540
/**
@@ -1569,6 +1574,7 @@ private constructor(
15691574
/** The operation to apply to the attribute */
15701575
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
15711576

1577+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
15721578
@JsonProperty("value") @ExcludeMissing fun _value() = value
15731579

15741580
@JsonAnyGetter
@@ -1691,8 +1697,10 @@ private constructor(
16911697
this.operation = operation
16921698
}
16931699

1700+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
16941701
fun value(value: Value) = value(JsonField.of(value))
16951702

1703+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
16961704
@JsonProperty("value")
16971705
@ExcludeMissing
16981706
fun value(value: JsonField<Value>) = apply { this.value = value }

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,6 +594,7 @@ private constructor(
594594
fun operation(): Optional<Operation> =
595595
Optional.ofNullable(operation.getNullable("operation"))
596596

597+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
597598
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
598599

599600
/**
@@ -633,6 +634,7 @@ private constructor(
633634
/** The operation to apply to the attribute */
634635
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
635636

637+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
636638
@JsonProperty("value") @ExcludeMissing fun _value() = value
637639

638640
@JsonAnyGetter
@@ -755,8 +757,10 @@ private constructor(
755757
this.operation = operation
756758
}
757759

760+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
758761
fun value(value: Value) = value(JsonField.of(value))
759762

763+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
760764
@JsonProperty("value")
761765
@ExcludeMissing
762766
fun value(value: JsonField<Value>) = apply { this.value = value }
@@ -1530,6 +1534,7 @@ private constructor(
15301534
fun operation(): Optional<Operation> =
15311535
Optional.ofNullable(operation.getNullable("operation"))
15321536

1537+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
15331538
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
15341539

15351540
/**
@@ -1569,6 +1574,7 @@ private constructor(
15691574
/** The operation to apply to the attribute */
15701575
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
15711576

1577+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
15721578
@JsonProperty("value") @ExcludeMissing fun _value() = value
15731579

15741580
@JsonAnyGetter
@@ -1691,8 +1697,10 @@ private constructor(
16911697
this.operation = operation
16921698
}
16931699

1700+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
16941701
fun value(value: Value) = value(JsonField.of(value))
16951702

1703+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
16961704
@JsonProperty("value")
16971705
@ExcludeMissing
16981706
fun value(value: JsonField<Value>) = apply { this.value = value }

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,6 +594,7 @@ private constructor(
594594
fun operation(): Optional<Operation> =
595595
Optional.ofNullable(operation.getNullable("operation"))
596596

597+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
597598
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
598599

599600
/**
@@ -633,6 +634,7 @@ private constructor(
633634
/** The operation to apply to the attribute */
634635
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
635636

637+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
636638
@JsonProperty("value") @ExcludeMissing fun _value() = value
637639

638640
@JsonAnyGetter
@@ -755,8 +757,10 @@ private constructor(
755757
this.operation = operation
756758
}
757759

760+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
758761
fun value(value: Value) = value(JsonField.of(value))
759762

763+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
760764
@JsonProperty("value")
761765
@ExcludeMissing
762766
fun value(value: JsonField<Value>) = apply { this.value = value }
@@ -1530,6 +1534,7 @@ private constructor(
15301534
fun operation(): Optional<Operation> =
15311535
Optional.ofNullable(operation.getNullable("operation"))
15321536

1537+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
15331538
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
15341539

15351540
/**
@@ -1569,6 +1574,7 @@ private constructor(
15691574
/** The operation to apply to the attribute */
15701575
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
15711576

1577+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
15721578
@JsonProperty("value") @ExcludeMissing fun _value() = value
15731579

15741580
@JsonAnyGetter
@@ -1691,8 +1697,10 @@ private constructor(
16911697
this.operation = operation
16921698
}
16931699

1700+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
16941701
fun value(value: Value) = value(JsonField.of(value))
16951702

1703+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
16961704
@JsonProperty("value")
16971705
@ExcludeMissing
16981706
fun value(value: JsonField<Value>) = apply { this.value = value }

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,6 +594,7 @@ private constructor(
594594
fun operation(): Optional<Operation> =
595595
Optional.ofNullable(operation.getNullable("operation"))
596596

597+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
597598
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
598599

599600
/**
@@ -633,6 +634,7 @@ private constructor(
633634
/** The operation to apply to the attribute */
634635
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
635636

637+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
636638
@JsonProperty("value") @ExcludeMissing fun _value() = value
637639

638640
@JsonAnyGetter
@@ -755,8 +757,10 @@ private constructor(
755757
this.operation = operation
756758
}
757759

760+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
758761
fun value(value: Value) = value(JsonField.of(value))
759762

763+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
760764
@JsonProperty("value")
761765
@ExcludeMissing
762766
fun value(value: JsonField<Value>) = apply { this.value = value }
@@ -1530,6 +1534,7 @@ private constructor(
15301534
fun operation(): Optional<Operation> =
15311535
Optional.ofNullable(operation.getNullable("operation"))
15321536

1537+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
15331538
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
15341539

15351540
/**
@@ -1569,6 +1574,7 @@ private constructor(
15691574
/** The operation to apply to the attribute */
15701575
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
15711576

1577+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
15721578
@JsonProperty("value") @ExcludeMissing fun _value() = value
15731579

15741580
@JsonAnyGetter
@@ -1691,8 +1697,10 @@ private constructor(
16911697
this.operation = operation
16921698
}
16931699

1700+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
16941701
fun value(value: Value) = value(JsonField.of(value))
16951702

1703+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
16961704
@JsonProperty("value")
16971705
@ExcludeMissing
16981706
fun value(value: JsonField<Value>) = apply { this.value = value }

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,6 +594,7 @@ private constructor(
594594
fun operation(): Optional<Operation> =
595595
Optional.ofNullable(operation.getNullable("operation"))
596596

597+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
597598
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
598599

599600
/**
@@ -633,6 +634,7 @@ private constructor(
633634
/** The operation to apply to the attribute */
634635
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
635636

637+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
636638
@JsonProperty("value") @ExcludeMissing fun _value() = value
637639

638640
@JsonAnyGetter
@@ -755,8 +757,10 @@ private constructor(
755757
this.operation = operation
756758
}
757759

760+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
758761
fun value(value: Value) = value(JsonField.of(value))
759762

763+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
760764
@JsonProperty("value")
761765
@ExcludeMissing
762766
fun value(value: JsonField<Value>) = apply { this.value = value }
@@ -1530,6 +1534,7 @@ private constructor(
15301534
fun operation(): Optional<Operation> =
15311535
Optional.ofNullable(operation.getNullable("operation"))
15321536

1537+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
15331538
fun value(): Optional<Value> = Optional.ofNullable(value.getNullable("value"))
15341539

15351540
/**
@@ -1569,6 +1574,7 @@ private constructor(
15691574
/** The operation to apply to the attribute */
15701575
@JsonProperty("operation") @ExcludeMissing fun _operation() = operation
15711576

1577+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
15721578
@JsonProperty("value") @ExcludeMissing fun _value() = value
15731579

15741580
@JsonAnyGetter
@@ -1691,8 +1697,10 @@ private constructor(
16911697
this.operation = operation
16921698
}
16931699

1700+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
16941701
fun value(value: Value) = value(JsonField.of(value))
16951702

1703+
/** A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` */
16961704
@JsonProperty("value")
16971705
@ExcludeMissing
16981706
fun value(value: JsonField<Value>) = apply { this.value = value }

0 commit comments

Comments
 (0)