feat(api): add state query param for cards (#19)

Author: stainless-bot

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

@@ -1,7 +1,11 @@
 package com.lithic.api.models
 
+import com.fasterxml.jackson.annotation.JsonCreator
+import com.lithic.api.core.JsonField
+import com.lithic.api.core.JsonValue
 import com.lithic.api.core.NoAutoDetect
 import com.lithic.api.core.toUnmodifiable
+import com.lithic.api.errors.LithicInvalidDataException
 import com.lithic.api.models.*
 import java.time.OffsetDateTime
 import java.util.Objects
@@ -10,6 +14,7 @@ import java.util.Optional
 class CardListParams
 constructor(
     private val accountToken: String?,
+    private val state: State?,
     private val begin: OffsetDateTime?,
     private val end: OffsetDateTime?,
     private val page: Long?,
@@ -20,6 +25,8 @@ constructor(
 
     fun accountToken(): Optional<String> = Optional.ofNullable(accountToken)
 
+    fun state(): Optional<State> = Optional.ofNullable(state)
+
     fun begin(): Optional<OffsetDateTime> = Optional.ofNullable(begin)
 
     fun end(): Optional<OffsetDateTime> = Optional.ofNullable(end)
@@ -32,6 +39,7 @@ constructor(
     internal fun getQueryParams(): Map<String, List<String>> {
         val params = mutableMapOf<String, List<String>>()
         this.accountToken?.let { params.put("account_token", listOf(it.toString())) }
+        this.state?.let { params.put("state", listOf(it.toString())) }
         this.begin?.let { params.put("begin", listOf(it.toString())) }
         this.end?.let { params.put("end", listOf(it.toString())) }
         this.page?.let { params.put("page", listOf(it.toString())) }
@@ -53,6 +61,7 @@ constructor(
 
         return other is CardListParams &&
             this.accountToken == other.accountToken &&
+            this.state == other.state &&
             this.begin == other.begin &&
             this.end == other.end &&
             this.page == other.page &&
@@ -64,6 +73,7 @@ constructor(
     override fun hashCode(): Int {
         return Objects.hash(
             accountToken,
+            state,
             begin,
             end,
             page,
@@ -74,7 +84,7 @@ constructor(
     }
 
     override fun toString() =
-        "CardListParams{accountToken=$accountToken, begin=$begin, end=$end, page=$page, pageSize=$pageSize, additionalQueryParams=$additionalQueryParams, additionalHeaders=$additionalHeaders}"
+        "CardListParams{accountToken=$accountToken, state=$state, begin=$begin, end=$end, page=$page, pageSize=$pageSize, additionalQueryParams=$additionalQueryParams, additionalHeaders=$additionalHeaders}"
 
     fun toBuilder() = Builder().from(this)
 
@@ -87,6 +97,7 @@ constructor(
     class Builder {
 
         private var accountToken: String? = null
+        private var state: State? = null
         private var begin: OffsetDateTime? = null
         private var end: OffsetDateTime? = null
         private var page: Long? = null
@@ -97,6 +108,7 @@ constructor(
         @JvmSynthetic
         internal fun from(cardListParams: CardListParams) = apply {
             this.accountToken = cardListParams.accountToken
+            this.state = cardListParams.state
             this.begin = cardListParams.begin
             this.end = cardListParams.end
             this.page = cardListParams.page
@@ -108,6 +120,9 @@ constructor(
         /** Returns cards associated with the specified account. */
         fun accountToken(accountToken: String) = apply { this.accountToken = accountToken }
 
+        /** Returns cards with the specified state. */
+        fun state(state: State) = apply { this.state = state }
+
         /**
          * Date string in RFC 3339 format. Only entries created after the specified date will be
          * included. UTC time zone.
@@ -169,6 +184,7 @@ constructor(
         fun build(): CardListParams =
             CardListParams(
                 accountToken,
+                state,
                 begin,
                 end,
                 page,
@@ -177,4 +193,79 @@ constructor(
                 additionalHeaders.mapValues { it.value.toUnmodifiable() }.toUnmodifiable(),
             )
     }
+
+    class State
+    @JsonCreator
+    private constructor(
+        private val value: JsonField<String>,
+    ) {
+
+        @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField<String> = value
+
+        override fun equals(other: Any?): Boolean {
+            if (this === other) {
+                return true
+            }
+
+            return other is State && this.value == other.value
+        }
+
+        override fun hashCode() = value.hashCode()
+
+        override fun toString() = value.toString()
+
+        companion object {
+
+            @JvmField val OPEN = State(JsonField.of("OPEN"))
+
+            @JvmField val PAUSED = State(JsonField.of("PAUSED"))
+
+            @JvmField val CLOSED = State(JsonField.of("CLOSED"))
+
+            @JvmField val PENDING_FULFILLMENT = State(JsonField.of("PENDING_FULFILLMENT"))
+
+            @JvmField val PENDING_ACTIVATION = State(JsonField.of("PENDING_ACTIVATION"))
+
+            @JvmStatic fun of(value: String) = State(JsonField.of(value))
+        }
+
+        enum class Known {
+            OPEN,
+            PAUSED,
+            CLOSED,
+            PENDING_FULFILLMENT,
+            PENDING_ACTIVATION,
+        }
+
+        enum class Value {
+            OPEN,
+            PAUSED,
+            CLOSED,
+            PENDING_FULFILLMENT,
+            PENDING_ACTIVATION,
+            _UNKNOWN,
+        }
+
+        fun value(): Value =
+            when (this) {
+                OPEN -> Value.OPEN
+                PAUSED -> Value.PAUSED
+                CLOSED -> Value.CLOSED
+                PENDING_FULFILLMENT -> Value.PENDING_FULFILLMENT
+                PENDING_ACTIVATION -> Value.PENDING_ACTIVATION
+                else -> Value._UNKNOWN
+            }
+
+        fun known(): Known =
+            when (this) {
+                OPEN -> Known.OPEN
+                PAUSED -> Known.PAUSED
+                CLOSED -> Known.CLOSED
+                PENDING_FULFILLMENT -> Known.PENDING_FULFILLMENT
+                PENDING_ACTIVATION -> Known.PENDING_ACTIVATION
+                else -> throw LithicInvalidDataException("Unknown State: $value")
+            }
+
+        fun asString(): String = _value().asStringOrThrow()
+    }
 }

lithic-java-core/src/test/kotlin/com/lithic/api/models/CardListParamsTest.kt

@@ -11,6 +11,7 @@ class CardListParamsTest {
     fun createCardListParams() {
         CardListParams.builder()
             .accountToken("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
+            .state(CardListParams.State.OPEN)
             .begin(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))
             .end(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))
             .page(123L)
@@ -23,13 +24,15 @@ class CardListParamsTest {
         val params =
             CardListParams.builder()
                 .accountToken("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
+                .state(CardListParams.State.OPEN)
                 .begin(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))
                 .end(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))
                 .page(123L)
                 .pageSize(123L)
                 .build()
         val expected = mutableMapOf<String, List<String>>()
         expected.put("account_token", listOf("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"))
+        expected.put("state", listOf(CardListParams.State.OPEN.toString()))
         expected.put("begin", listOf("2019-12-27T18:11:19.117Z"))
         expected.put("end", listOf("2019-12-27T18:11:19.117Z"))
         expected.put("page", listOf("123"))

lithic-java-core/src/test/kotlin/com/lithic/api/services/ServiceParamsTest.kt

@@ -149,6 +149,7 @@ class ServiceParamsTest {
         val params =
             CardListParams.builder()
                 .accountToken("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
+                .state(CardListParams.State.OPEN)
                 .begin(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))
                 .end(OffsetDateTime.parse("2019-12-27T18:11:19.117Z"))
                 .page(123L)