Skip to content

Commit 5b09b99

Browse files
stainless-app[bot]stainless-app[bot]
committed
docs: add more documentation (#699)
1 parent 12b19e8 commit 5b09b99

File tree

209 files changed

+10258
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

209 files changed

+10258
-2
lines changed

‎buildSrc/src/main/kotlin/increase.kotlin.gradle.kts‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,12 @@ configure<SpotlessExtension> {
2121

2222
tasks.withType<KotlinCompile>().configureEach {
2323
kotlinOptions {
24-
allWarningsAsErrors = true
25-
freeCompilerArgs = listOf("-Xjvm-default=all", "-Xjdk-release=1.8")
24+
freeCompilerArgs = listOf(
25+
"-Xjvm-default=all",
26+
"-Xjdk-release=1.8",
27+
// Suppress deprecation warnings because we may still reference and test deprecated members.
28+
"-Xsuppress-warning=DEPRECATION"
29+
)
2630
jvmTarget = "1.8"
2731
}
2832
}

‎increase-java-core/src/main/kotlin/com/increase/api/models/Account.kt‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -525,6 +525,7 @@ private constructor(
525525
)
526526
}
527527

528+
/** The bank the Account is with. */
528529
class Bank
529530
@JsonCreator
530531
private constructor(
@@ -545,14 +546,20 @@ private constructor(
545546
}
546547

547548
enum class Known {
549+
/** Blue Ridge Bank, N.A. */
548550
BLUE_RIDGE_BANK,
551+
/** First Internet Bank of Indiana */
549552
FIRST_INTERNET_BANK,
553+
/** Grasshopper Bank */
550554
GRASSHOPPER_BANK,
551555
}
552556

553557
enum class Value {
558+
/** Blue Ridge Bank, N.A. */
554559
BLUE_RIDGE_BANK,
560+
/** First Internet Bank of Indiana */
555561
FIRST_INTERNET_BANK,
562+
/** Grasshopper Bank */
556563
GRASSHOPPER_BANK,
557564
_UNKNOWN,
558565
}
@@ -588,6 +595,7 @@ private constructor(
588595
override fun toString() = value.toString()
589596
}
590597

598+
/** The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account currency. */
591599
class Currency
592600
@JsonCreator
593601
private constructor(
@@ -614,20 +622,32 @@ private constructor(
614622
}
615623

616624
enum class Known {
625+
/** Canadian Dollar (CAD) */
617626
CAD,
627+
/** Swiss Franc (CHF) */
618628
CHF,
629+
/** Euro (EUR) */
619630
EUR,
631+
/** British Pound (GBP) */
620632
GBP,
633+
/** Japanese Yen (JPY) */
621634
JPY,
635+
/** US Dollar (USD) */
622636
USD,
623637
}
624638

625639
enum class Value {
640+
/** Canadian Dollar (CAD) */
626641
CAD,
642+
/** Swiss Franc (CHF) */
627643
CHF,
644+
/** Euro (EUR) */
628645
EUR,
646+
/** British Pound (GBP) */
629647
GBP,
648+
/** Japanese Yen (JPY) */
630649
JPY,
650+
/** US Dollar (USD) */
631651
USD,
632652
_UNKNOWN,
633653
}
@@ -669,6 +689,7 @@ private constructor(
669689
override fun toString() = value.toString()
670690
}
671691

692+
/** The status of the Account. */
672693
class Status
673694
@JsonCreator
674695
private constructor(
@@ -687,12 +708,16 @@ private constructor(
687708
}
688709

689710
enum class Known {
711+
/** Closed Accounts on which no new activity can occur. */
690712
CLOSED,
713+
/** Open Accounts that are ready to use. */
691714
OPEN,
692715
}
693716

694717
enum class Value {
718+
/** Closed Accounts on which no new activity can occur. */
695719
CLOSED,
720+
/** Open Accounts that are ready to use. */
696721
OPEN,
697722
_UNKNOWN,
698723
}
@@ -726,6 +751,7 @@ private constructor(
726751
override fun toString() = value.toString()
727752
}
728753

754+
/** A constant representing the object's type. For this resource it will always be `account`. */
729755
class Type
730756
@JsonCreator
731757
private constructor(

‎increase-java-core/src/main/kotlin/com/increase/api/models/AccountListPage.kt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import java.util.Optional
1919
import java.util.stream.Stream
2020
import java.util.stream.StreamSupport
2121

22+
/** List Accounts */
2223
class AccountListPage
2324
private constructor(
2425
private val accountsService: AccountService,

‎increase-java-core/src/main/kotlin/com/increase/api/models/AccountListPageAsync.kt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import java.util.concurrent.CompletableFuture
2020
import java.util.concurrent.Executor
2121
import java.util.function.Predicate
2222

23+
/** List Accounts */
2324
class AccountListPageAsync
2425
private constructor(
2526
private val accountsService: AccountServiceAsync,

‎increase-java-core/src/main/kotlin/com/increase/api/models/AccountListParams.kt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,7 @@ constructor(
499499
"CreatedAt{after=$after, before=$before, onOrAfter=$onOrAfter, onOrBefore=$onOrBefore, additionalProperties=$additionalProperties}"
500500
}
501501

502+
/** Filter Accounts for those with the specified status. */
502503
class Status
503504
@JsonCreator
504505
private constructor(
@@ -517,12 +518,16 @@ constructor(
517518
}
518519

519520
enum class Known {
521+
/** Closed Accounts on which no new activity can occur. */
520522
CLOSED,
523+
/** Open Accounts that are ready to use. */
521524
OPEN,
522525
}
523526

524527
enum class Value {
528+
/** Closed Accounts on which no new activity can occur. */
525529
CLOSED,
530+
/** Open Accounts that are ready to use. */
526531
OPEN,
527532
_UNKNOWN,
528533
}

‎increase-java-core/src/main/kotlin/com/increase/api/models/AccountNumber.kt‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -464,6 +464,10 @@ private constructor(
464464
)
465465
}
466466

467+
/**
468+
* Whether ACH debits are allowed against this Account Number. Note that they will still be
469+
* declined if this is `allowed` if the Account Number is not active.
470+
*/
467471
class DebitStatus
468472
@JsonCreator
469473
private constructor(
@@ -482,12 +486,16 @@ private constructor(
482486
}
483487

484488
enum class Known {
489+
/** ACH Debits are allowed. */
485490
ALLOWED,
491+
/** ACH Debits are blocked. */
486492
BLOCKED,
487493
}
488494

489495
enum class Value {
496+
/** ACH Debits are allowed. */
490497
ALLOWED,
498+
/** ACH Debits are blocked. */
491499
BLOCKED,
492500
_UNKNOWN,
493501
}
@@ -619,6 +627,7 @@ private constructor(
619627
InboundChecks(checkRequired("status", status), additionalProperties.toImmutable())
620628
}
621629

630+
/** How Increase should process checks with this account number printed on them. */
622631
class Status
623632
@JsonCreator
624633
private constructor(
@@ -637,12 +646,28 @@ private constructor(
637646
}
638647

639648
enum class Known {
649+
/**
650+
* Checks with this Account Number will be processed even if they are not associated
651+
* with a Check Transfer.
652+
*/
640653
ALLOWED,
654+
/**
655+
* Checks with this Account Number will be processed only if they can be matched to
656+
* an existing Check Transfer.
657+
*/
641658
CHECK_TRANSFERS_ONLY,
642659
}
643660

644661
enum class Value {
662+
/**
663+
* Checks with this Account Number will be processed even if they are not associated
664+
* with a Check Transfer.
665+
*/
645666
ALLOWED,
667+
/**
668+
* Checks with this Account Number will be processed only if they can be matched to
669+
* an existing Check Transfer.
670+
*/
646671
CHECK_TRANSFERS_ONLY,
647672
_UNKNOWN,
648673
}
@@ -694,6 +719,7 @@ private constructor(
694719
"InboundChecks{status=$status, additionalProperties=$additionalProperties}"
695720
}
696721

722+
/** This indicates if payments can be made to the Account Number. */
697723
class Status
698724
@JsonCreator
699725
private constructor(
@@ -714,14 +740,20 @@ private constructor(
714740
}
715741

716742
enum class Known {
743+
/** The account number is active. */
717744
ACTIVE,
745+
/** The account number is temporarily disabled. */
718746
DISABLED,
747+
/** The account number is permanently disabled. */
719748
CANCELED,
720749
}
721750

722751
enum class Value {
752+
/** The account number is active. */
723753
ACTIVE,
754+
/** The account number is temporarily disabled. */
724755
DISABLED,
756+
/** The account number is permanently disabled. */
725757
CANCELED,
726758
_UNKNOWN,
727759
}
@@ -757,6 +789,10 @@ private constructor(
757789
override fun toString() = value.toString()
758790
}
759791

792+
/**
793+
* A constant representing the object's type. For this resource it will always be
794+
* `account_number`.
795+
*/
760796
class Type
761797
@JsonCreator
762798
private constructor(

‎increase-java-core/src/main/kotlin/com/increase/api/models/AccountNumberCreateParams.kt‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,11 @@ constructor(
514514
)
515515
}
516516

517+
/**
518+
* Whether ACH debits are allowed against this Account Number. Note that ACH debits will be
519+
* declined if this is `allowed` but the Account Number is not active. If you do not specify
520+
* this field, the default is `allowed`.
521+
*/
517522
class DebitStatus
518523
@JsonCreator
519524
private constructor(
@@ -532,12 +537,16 @@ constructor(
532537
}
533538

534539
enum class Known {
540+
/** ACH Debits are allowed. */
535541
ALLOWED,
542+
/** ACH Debits are blocked. */
536543
BLOCKED,
537544
}
538545

539546
enum class Value {
547+
/** ACH Debits are allowed. */
540548
ALLOWED,
549+
/** ACH Debits are blocked. */
541550
BLOCKED,
542551
_UNKNOWN,
543552
}
@@ -681,6 +690,10 @@ constructor(
681690
InboundChecks(checkRequired("status", status), additionalProperties.toImmutable())
682691
}
683692

693+
/**
694+
* How Increase should process checks with this account number printed on them. If you do
695+
* not specify this field, the default is `check_transfers_only`.
696+
*/
684697
class Status
685698
@JsonCreator
686699
private constructor(
@@ -699,12 +712,28 @@ constructor(
699712
}
700713

701714
enum class Known {
715+
/**
716+
* Checks with this Account Number will be processed even if they are not associated
717+
* with a Check Transfer.
718+
*/
702719
ALLOWED,
720+
/**
721+
* Checks with this Account Number will be processed only if they can be matched to
722+
* an existing Check Transfer.
723+
*/
703724
CHECK_TRANSFERS_ONLY,
704725
}
705726

706727
enum class Value {
728+
/**
729+
* Checks with this Account Number will be processed even if they are not associated
730+
* with a Check Transfer.
731+
*/
707732
ALLOWED,
733+
/**
734+
* Checks with this Account Number will be processed only if they can be matched to
735+
* an existing Check Transfer.
736+
*/
708737
CHECK_TRANSFERS_ONLY,
709738
_UNKNOWN,
710739
}

‎increase-java-core/src/main/kotlin/com/increase/api/models/AccountNumberListPage.kt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import java.util.Optional
1919
import java.util.stream.Stream
2020
import java.util.stream.StreamSupport
2121

22+
/** List Account Numbers */
2223
class AccountNumberListPage
2324
private constructor(
2425
private val accountNumbersService: AccountNumberService,

‎increase-java-core/src/main/kotlin/com/increase/api/models/AccountNumberListPageAsync.kt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import java.util.concurrent.CompletableFuture
2020
import java.util.concurrent.Executor
2121
import java.util.function.Predicate
2222

23+
/** List Account Numbers */
2324
class AccountNumberListPageAsync
2425
private constructor(
2526
private val accountNumbersService: AccountNumberServiceAsync,

0 commit comments

Comments
 (0)