Skip to content

fix(docs): expand check transfer shipping method descriptions #1394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
increase-releases merged 1 commit into from
Jul 20, 2026
Merged

fix(docs): expand check transfer shipping method descriptions #1394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
configured_endpoints: 239
openapi_spec_hash: f6a1f4bde6efb971145f60df61c0f8cc
openapi_spec_hash: ec98ee98f7777d5d0f87bcb178e47d8d
config_hash: 1ca082e374ef7000e2a5971e8da740e0
30 changes: 24 additions & 6 deletions increase-java-core/src/main/kotlin/com/increase/api/models/checktransfers/CheckTransfer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5154,20 +5154,32 @@ private constructor(

companion object {

/** USPS First Class */
/**
* Ship the checks via USPS First Class, which supports a maximum of 1000 pages
* (checks and attachments combined).
*/
@JvmField val USPS_FIRST_CLASS = of("usps_first_class")

/** FedEx Overnight */
/**
* Ship the checks via FedEx Overnight, which supports a maximum of 50 pages (checks
* and attachments combined).
*/
@JvmField val FEDEX_OVERNIGHT = of("fedex_overnight")

@JvmStatic fun of(value: String) = ShippingMethod(JsonField.of(value))
}

/** An enum containing [ShippingMethod]'s known values. */
enum class Known {
/** USPS First Class */
/**
* Ship the checks via USPS First Class, which supports a maximum of 1000 pages
* (checks and attachments combined).
*/
USPS_FIRST_CLASS,
/** FedEx Overnight */
/**
* Ship the checks via FedEx Overnight, which supports a maximum of 50 pages (checks
* and attachments combined).
*/
FEDEX_OVERNIGHT,
}

Expand All @@ -5181,9 +5193,15 @@ private constructor(
* - It was constructed with an arbitrary value using the [of] method.
*/
enum class Value {
/** USPS First Class */
/**
* Ship the checks via USPS First Class, which supports a maximum of 1000 pages
* (checks and attachments combined).
*/
USPS_FIRST_CLASS,
/** FedEx Overnight */
/**
* Ship the checks via FedEx Overnight, which supports a maximum of 50 pages (checks
* and attachments combined).
*/
FEDEX_OVERNIGHT,
/**
* An enum member indicating that [ShippingMethod] was instantiated with an unknown
Expand Down
30 changes: 24 additions & 6 deletions ...-core/src/main/kotlin/com/increase/api/models/checktransfers/CheckTransferCreateParams.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3166,20 +3166,32 @@ private constructor(

companion object {

/** USPS First Class */
/**
* Ship the checks via USPS First Class, which supports a maximum of 1000 pages
* (checks and attachments combined).
*/
@JvmField val USPS_FIRST_CLASS = of("usps_first_class")

/** FedEx Overnight */
/**
* Ship the checks via FedEx Overnight, which supports a maximum of 50 pages (checks
* and attachments combined).
*/
@JvmField val FEDEX_OVERNIGHT = of("fedex_overnight")

@JvmStatic fun of(value: String) = ShippingMethod(JsonField.of(value))
}

/** An enum containing [ShippingMethod]'s known values. */
enum class Known {
/** USPS First Class */
/**
* Ship the checks via USPS First Class, which supports a maximum of 1000 pages
* (checks and attachments combined).
*/
USPS_FIRST_CLASS,
/** FedEx Overnight */
/**
* Ship the checks via FedEx Overnight, which supports a maximum of 50 pages (checks
* and attachments combined).
*/
FEDEX_OVERNIGHT,
}

Expand All @@ -3193,9 +3205,15 @@ private constructor(
* - It was constructed with an arbitrary value using the [of] method.
*/
enum class Value {
/** USPS First Class */
/**
* Ship the checks via USPS First Class, which supports a maximum of 1000 pages
* (checks and attachments combined).
*/
USPS_FIRST_CLASS,
/** FedEx Overnight */
/**
* Ship the checks via FedEx Overnight, which supports a maximum of 50 pages (checks
* and attachments combined).
*/
FEDEX_OVERNIGHT,
/**
* An enum member indicating that [ShippingMethod] was instantiated with an unknown
Expand Down
24 changes: 12 additions & 12 deletions ...lin/com/increase/api/models/pendingtransactions/PendingTransactionListPageResponseTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ internal class PendingTransactionListPageResponseTest {
PendingTransaction.builder()
.id("pending_transaction_k1sfetcau2qbvjbzgju4")
.accountId("account_in71c4amph0vgo2qllky")
.amount(100L)
.amount(-100L)
.completedAt(null)
.createdAt(OffsetDateTime.parse("2020-01-31T23:59:59Z"))
.currency(PendingTransaction.Currency.USD)
.description("INVOICE 2468")
.heldAmount(100L)
.routeId("card_oubs0hwk5rn6knuecxg2")
.routeType(PendingTransaction.RouteType.CARD)
.heldAmount(-100L)
.routeId(null)
.routeType(null)
.source(
PendingTransaction.Source.builder()
.category(
Expand Down Expand Up @@ -484,14 +484,14 @@ internal class PendingTransactionListPageResponseTest {
PendingTransaction.builder()
.id("pending_transaction_k1sfetcau2qbvjbzgju4")
.accountId("account_in71c4amph0vgo2qllky")
.amount(100L)
.amount(-100L)
.completedAt(null)
.createdAt(OffsetDateTime.parse("2020-01-31T23:59:59Z"))
.currency(PendingTransaction.Currency.USD)
.description("INVOICE 2468")
.heldAmount(100L)
.routeId("card_oubs0hwk5rn6knuecxg2")
.routeType(PendingTransaction.RouteType.CARD)
.heldAmount(-100L)
.routeId(null)
.routeType(null)
.source(
PendingTransaction.Source.builder()
.category(PendingTransaction.Source.Category.ACH_TRANSFER_INSTRUCTION)
Expand Down Expand Up @@ -931,14 +931,14 @@ internal class PendingTransactionListPageResponseTest {
PendingTransaction.builder()
.id("pending_transaction_k1sfetcau2qbvjbzgju4")
.accountId("account_in71c4amph0vgo2qllky")
.amount(100L)
.amount(-100L)
.completedAt(null)
.createdAt(OffsetDateTime.parse("2020-01-31T23:59:59Z"))
.currency(PendingTransaction.Currency.USD)
.description("INVOICE 2468")
.heldAmount(100L)
.routeId("card_oubs0hwk5rn6knuecxg2")
.routeType(PendingTransaction.RouteType.CARD)
.heldAmount(-100L)
.routeId(null)
.routeType(null)
.source(
PendingTransaction.Source.builder()
.category(
Expand Down
24 changes: 12 additions & 12 deletions ...ore/src/test/kotlin/com/increase/api/models/pendingtransactions/PendingTransactionTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ internal class PendingTransactionTest {
PendingTransaction.builder()
.id("pending_transaction_k1sfetcau2qbvjbzgju4")
.accountId("account_in71c4amph0vgo2qllky")
.amount(100L)
.amount(-100L)
.completedAt(null)
.createdAt(OffsetDateTime.parse("2020-01-31T23:59:59Z"))
.currency(PendingTransaction.Currency.USD)
.description("INVOICE 2468")
.heldAmount(100L)
.routeId("card_oubs0hwk5rn6knuecxg2")
.routeType(PendingTransaction.RouteType.CARD)
.heldAmount(-100L)
.routeId(null)
.routeType(null)
.source(
PendingTransaction.Source.builder()
.category(PendingTransaction.Source.Category.ACH_TRANSFER_INSTRUCTION)
Expand Down Expand Up @@ -427,15 +427,15 @@ internal class PendingTransactionTest {

assertThat(pendingTransaction.id()).isEqualTo("pending_transaction_k1sfetcau2qbvjbzgju4")
assertThat(pendingTransaction.accountId()).isEqualTo("account_in71c4amph0vgo2qllky")
assertThat(pendingTransaction.amount()).isEqualTo(100L)
assertThat(pendingTransaction.amount()).isEqualTo(-100L)
assertThat(pendingTransaction.completedAt()).isEmpty
assertThat(pendingTransaction.createdAt())
.isEqualTo(OffsetDateTime.parse("2020-01-31T23:59:59Z"))
assertThat(pendingTransaction.currency()).isEqualTo(PendingTransaction.Currency.USD)
assertThat(pendingTransaction.description()).isEqualTo("INVOICE 2468")
assertThat(pendingTransaction.heldAmount()).isEqualTo(100L)
assertThat(pendingTransaction.routeId()).contains("card_oubs0hwk5rn6knuecxg2")
assertThat(pendingTransaction.routeType()).contains(PendingTransaction.RouteType.CARD)
assertThat(pendingTransaction.heldAmount()).isEqualTo(-100L)
assertThat(pendingTransaction.routeId()).isEmpty
assertThat(pendingTransaction.routeType()).isEmpty
assertThat(pendingTransaction.source())
.isEqualTo(
PendingTransaction.Source.builder()
Expand Down Expand Up @@ -827,14 +827,14 @@ internal class PendingTransactionTest {
PendingTransaction.builder()
.id("pending_transaction_k1sfetcau2qbvjbzgju4")
.accountId("account_in71c4amph0vgo2qllky")
.amount(100L)
.amount(-100L)
.completedAt(null)
.createdAt(OffsetDateTime.parse("2020-01-31T23:59:59Z"))
.currency(PendingTransaction.Currency.USD)
.description("INVOICE 2468")
.heldAmount(100L)
.routeId("card_oubs0hwk5rn6knuecxg2")
.routeType(PendingTransaction.RouteType.CARD)
.heldAmount(-100L)
.routeId(null)
.routeType(null)
.source(
PendingTransaction.Source.builder()
.category(PendingTransaction.Source.Category.ACH_TRANSFER_INSTRUCTION)
Expand Down
2 changes: 1 addition & 1 deletion scripts/mock
View file
Open in desktop

Large diffs are not rendered by default.

Loading