Skip to content

Commit 3c8956e

Browse files
stainless-app[bot]stainless-app[bot]
authored
docs: more enum documentation (#702)
1 parent dd877bb commit 3c8956e

File tree

99 files changed

+4561
-0
lines changed

Some content is hidden

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

99 files changed

+4561
-0
lines changed

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -536,10 +536,13 @@ private constructor(
536536

537537
companion object {
538538

539+
/** Blue Ridge Bank, N.A. */
539540
@JvmField val BLUE_RIDGE_BANK = of("blue_ridge_bank")
540541

542+
/** First Internet Bank of Indiana */
541543
@JvmField val FIRST_INTERNET_BANK = of("first_internet_bank")
542544

545+
/** Grasshopper Bank */
543546
@JvmField val GRASSHOPPER_BANK = of("grasshopper_bank")
544547

545548
@JvmStatic fun of(value: String) = Bank(JsonField.of(value))
@@ -606,16 +609,22 @@ private constructor(
606609

607610
companion object {
608611

612+
/** Canadian Dollar (CAD) */
609613
@JvmField val CAD = of("CAD")
610614

615+
/** Swiss Franc (CHF) */
611616
@JvmField val CHF = of("CHF")
612617

618+
/** Euro (EUR) */
613619
@JvmField val EUR = of("EUR")
614620

621+
/** British Pound (GBP) */
615622
@JvmField val GBP = of("GBP")
616623

624+
/** Japanese Yen (JPY) */
617625
@JvmField val JPY = of("JPY")
618626

627+
/** US Dollar (USD) */
619628
@JvmField val USD = of("USD")
620629

621630
@JvmStatic fun of(value: String) = Currency(JsonField.of(value))
@@ -700,8 +709,10 @@ private constructor(
700709

701710
companion object {
702711

712+
/** Closed Accounts on which no new activity can occur. */
703713
@JvmField val CLOSED = of("closed")
704714

715+
/** Open Accounts that are ready to use. */
705716
@JvmField val OPEN = of("open")
706717

707718
@JvmStatic fun of(value: String) = Status(JsonField.of(value))

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -510,8 +510,10 @@ constructor(
510510

511511
companion object {
512512

513+
/** Closed Accounts on which no new activity can occur. */
513514
@JvmField val CLOSED = of("closed")
514515

516+
/** Open Accounts that are ready to use. */
515517
@JvmField val OPEN = of("open")
516518

517519
@JvmStatic fun of(value: String) = Status(JsonField.of(value))

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -478,8 +478,10 @@ private constructor(
478478

479479
companion object {
480480

481+
/** ACH Debits are allowed. */
481482
@JvmField val ALLOWED = of("allowed")
482483

484+
/** ACH Debits are blocked. */
483485
@JvmField val BLOCKED = of("blocked")
484486

485487
@JvmStatic fun of(value: String) = DebitStatus(JsonField.of(value))
@@ -638,8 +640,16 @@ private constructor(
638640

639641
companion object {
640642

643+
/**
644+
* Checks with this Account Number will be processed even if they are not associated
645+
* with a Check Transfer.
646+
*/
641647
@JvmField val ALLOWED = of("allowed")
642648

649+
/**
650+
* Checks with this Account Number will be processed only if they can be matched to
651+
* an existing Check Transfer.
652+
*/
643653
@JvmField val CHECK_TRANSFERS_ONLY = of("check_transfers_only")
644654

645655
@JvmStatic fun of(value: String) = Status(JsonField.of(value))
@@ -730,10 +740,13 @@ private constructor(
730740

731741
companion object {
732742

743+
/** The account number is active. */
733744
@JvmField val ACTIVE = of("active")
734745

746+
/** The account number is temporarily disabled. */
735747
@JvmField val DISABLED = of("disabled")
736748

749+
/** The account number is permanently disabled. */
737750
@JvmField val CANCELED = of("canceled")
738751

739752
@JvmStatic fun of(value: String) = Status(JsonField.of(value))

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -529,8 +529,10 @@ constructor(
529529

530530
companion object {
531531

532+
/** ACH Debits are allowed. */
532533
@JvmField val ALLOWED = of("allowed")
533534

535+
/** ACH Debits are blocked. */
534536
@JvmField val BLOCKED = of("blocked")
535537

536538
@JvmStatic fun of(value: String) = DebitStatus(JsonField.of(value))
@@ -704,8 +706,16 @@ constructor(
704706

705707
companion object {
706708

709+
/**
710+
* Checks with this Account Number will be processed even if they are not associated
711+
* with a Check Transfer.
712+
*/
707713
@JvmField val ALLOWED = of("allowed")
708714

715+
/**
716+
* Checks with this Account Number will be processed only if they can be matched to
717+
* an existing Check Transfer.
718+
*/
709719
@JvmField val CHECK_TRANSFERS_ONLY = of("check_transfers_only")
710720

711721
@JvmStatic fun of(value: String) = Status(JsonField.of(value))

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -294,8 +294,10 @@ constructor(
294294

295295
companion object {
296296

297+
/** ACH Debits are allowed. */
297298
@JvmField val ALLOWED = of("allowed")
298299

300+
/** ACH Debits are blocked. */
299301
@JvmField val BLOCKED = of("blocked")
300302

301303
@JvmStatic fun of(value: String) = AchDebitStatus(JsonField.of(value))
@@ -556,10 +558,13 @@ constructor(
556558

557559
companion object {
558560

561+
/** The account number is active. */
559562
@JvmField val ACTIVE = of("active")
560563

564+
/** The account number is temporarily disabled. */
561565
@JvmField val DISABLED = of("disabled")
562566

567+
/** The account number is permanently disabled. */
563568
@JvmField val CANCELED = of("canceled")
564569

565570
@JvmStatic fun of(value: String) = Status(JsonField.of(value))

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -540,8 +540,10 @@ constructor(
540540

541541
companion object {
542542

543+
/** ACH Debits are allowed. */
543544
@JvmField val ALLOWED = of("allowed")
544545

546+
/** ACH Debits are blocked. */
545547
@JvmField val BLOCKED = of("blocked")
546548

547549
@JvmStatic fun of(value: String) = DebitStatus(JsonField.of(value))
@@ -700,8 +702,16 @@ constructor(
700702

701703
companion object {
702704

705+
/**
706+
* Checks with this Account Number will be processed even if they are not associated
707+
* with a Check Transfer.
708+
*/
703709
@JvmField val ALLOWED = of("allowed")
704710

711+
/**
712+
* Checks with this Account Number will be processed only if they can be matched to
713+
* an existing Check Transfer.
714+
*/
705715
@JvmField val CHECK_TRANSFERS_ONLY = of("check_transfers_only")
706716

707717
@JvmStatic fun of(value: String) = Status(JsonField.of(value))
@@ -792,10 +802,13 @@ constructor(
792802

793803
companion object {
794804

805+
/** The account number is active. */
795806
@JvmField val ACTIVE = of("active")
796807

808+
/** The account number is temporarily disabled. */
797809
@JvmField val DISABLED = of("disabled")
798810

811+
/** The account number is permanently disabled. */
799812
@JvmField val CANCELED = of("canceled")
800813

801814
@JvmStatic fun of(value: String) = Status(JsonField.of(value))

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1181,10 +1181,16 @@ private constructor(
11811181

11821182
companion object {
11831183

1184+
/** An API key. Details will be under the `api_key` object. */
11841185
@JvmField val API_KEY = of("api_key")
11851186

1187+
/**
1188+
* An OAuth application you connected to Increase. Details will be under the
1189+
* `oauth_application` object.
1190+
*/
11861191
@JvmField val OAUTH_APPLICATION = of("oauth_application")
11871192

1193+
/** A User in the Increase dashboard. Details will be under the `user` object. */
11881194
@JvmField val USER = of("user")
11891195

11901196
@JvmStatic fun of(value: String) = Category(JsonField.of(value))
@@ -1483,16 +1489,22 @@ private constructor(
14831489

14841490
companion object {
14851491

1492+
/** Canadian Dollar (CAD) */
14861493
@JvmField val CAD = of("CAD")
14871494

1495+
/** Swiss Franc (CHF) */
14881496
@JvmField val CHF = of("CHF")
14891497

1498+
/** Euro (EUR) */
14901499
@JvmField val EUR = of("EUR")
14911500

1501+
/** British Pound (GBP) */
14921502
@JvmField val GBP = of("GBP")
14931503

1504+
/** Japanese Yen (JPY) */
14941505
@JvmField val JPY = of("JPY")
14951506

1507+
/** US Dollar (USD) */
14961508
@JvmField val USD = of("USD")
14971509

14981510
@JvmStatic fun of(value: String) = Currency(JsonField.of(value))
@@ -1629,10 +1641,13 @@ private constructor(
16291641

16301642
companion object {
16311643

1644+
/** The transfer is pending approval. */
16321645
@JvmField val PENDING_APPROVAL = of("pending_approval")
16331646

1647+
/** The transfer has been canceled. */
16341648
@JvmField val CANCELED = of("canceled")
16351649

1650+
/** The transfer has been completed. */
16361651
@JvmField val COMPLETE = of("complete")
16371652

16381653
@JvmStatic fun of(value: String) = Status(JsonField.of(value))

0 commit comments

Comments
 (0)