com.increase.api.models.EntitySupplementalDocument.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of increase-java-core Show documentation
Show all versions of increase-java-core Show documentation
An SDK library for increase
// File generated from our OpenAPI spec by Stainless.
package com.increase.api.models
import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonAnySetter
import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
import com.increase.api.core.Enum
import com.increase.api.core.ExcludeMissing
import com.increase.api.core.JsonField
import com.increase.api.core.JsonMissing
import com.increase.api.core.JsonValue
import com.increase.api.core.NoAutoDetect
import com.increase.api.core.toUnmodifiable
import com.increase.api.errors.IncreaseInvalidDataException
import java.time.OffsetDateTime
import java.util.Objects
import java.util.Optional
/** Supplemental Documents are uploaded files connected to an Entity during onboarding. */
@JsonDeserialize(builder = EntitySupplementalDocument.Builder::class)
@NoAutoDetect
class EntitySupplementalDocument
private constructor(
private val createdAt: JsonField,
private val entityId: JsonField,
private val fileId: JsonField,
private val idempotencyKey: JsonField,
private val type: JsonField,
private val additionalProperties: Map,
) {
private var validated: Boolean = false
private var hashCode: Int = 0
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplemental
* Document was created.
*/
fun createdAt(): OffsetDateTime = createdAt.getRequired("created_at")
/** The Entity the supplemental document is attached to. */
fun entityId(): String = entityId.getRequired("entity_id")
/** The File containing the document. */
fun fileId(): String = fileId.getRequired("file_id")
/**
* The idempotency key you chose for this object. This value is unique across Increase and is
* used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
fun idempotencyKey(): Optional =
Optional.ofNullable(idempotencyKey.getNullable("idempotency_key"))
/**
* A constant representing the object's type. For this resource it will always be
* `entity_supplemental_document`.
*/
fun type(): Type = type.getRequired("type")
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplemental
* Document was created.
*/
@JsonProperty("created_at") @ExcludeMissing fun _createdAt() = createdAt
/** The Entity the supplemental document is attached to. */
@JsonProperty("entity_id") @ExcludeMissing fun _entityId() = entityId
/** The File containing the document. */
@JsonProperty("file_id") @ExcludeMissing fun _fileId() = fileId
/**
* The idempotency key you chose for this object. This value is unique across Increase and is
* used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
@JsonProperty("idempotency_key") @ExcludeMissing fun _idempotencyKey() = idempotencyKey
/**
* A constant representing the object's type. For this resource it will always be
* `entity_supplemental_document`.
*/
@JsonProperty("type") @ExcludeMissing fun _type() = type
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun validate(): EntitySupplementalDocument = apply {
if (!validated) {
createdAt()
entityId()
fileId()
idempotencyKey()
type()
validated = true
}
}
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is EntitySupplementalDocument &&
this.createdAt == other.createdAt &&
this.entityId == other.entityId &&
this.fileId == other.fileId &&
this.idempotencyKey == other.idempotencyKey &&
this.type == other.type &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
createdAt,
entityId,
fileId,
idempotencyKey,
type,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"EntitySupplementalDocument{createdAt=$createdAt, entityId=$entityId, fileId=$fileId, idempotencyKey=$idempotencyKey, type=$type, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var createdAt: JsonField = JsonMissing.of()
private var entityId: JsonField = JsonMissing.of()
private var fileId: JsonField = JsonMissing.of()
private var idempotencyKey: JsonField = JsonMissing.of()
private var type: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(entitySupplementalDocument: EntitySupplementalDocument) = apply {
this.createdAt = entitySupplementalDocument.createdAt
this.entityId = entitySupplementalDocument.entityId
this.fileId = entitySupplementalDocument.fileId
this.idempotencyKey = entitySupplementalDocument.idempotencyKey
this.type = entitySupplementalDocument.type
additionalProperties(entitySupplementalDocument.additionalProperties)
}
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplemental
* Document was created.
*/
fun createdAt(createdAt: OffsetDateTime) = createdAt(JsonField.of(createdAt))
/**
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplemental
* Document was created.
*/
@JsonProperty("created_at")
@ExcludeMissing
fun createdAt(createdAt: JsonField) = apply { this.createdAt = createdAt }
/** The Entity the supplemental document is attached to. */
fun entityId(entityId: String) = entityId(JsonField.of(entityId))
/** The Entity the supplemental document is attached to. */
@JsonProperty("entity_id")
@ExcludeMissing
fun entityId(entityId: JsonField) = apply { this.entityId = entityId }
/** The File containing the document. */
fun fileId(fileId: String) = fileId(JsonField.of(fileId))
/** The File containing the document. */
@JsonProperty("file_id")
@ExcludeMissing
fun fileId(fileId: JsonField) = apply { this.fileId = fileId }
/**
* The idempotency key you chose for this object. This value is unique across Increase and
* is used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
fun idempotencyKey(idempotencyKey: String) = idempotencyKey(JsonField.of(idempotencyKey))
/**
* The idempotency key you chose for this object. This value is unique across Increase and
* is used to ensure that a request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
@JsonProperty("idempotency_key")
@ExcludeMissing
fun idempotencyKey(idempotencyKey: JsonField) = apply {
this.idempotencyKey = idempotencyKey
}
/**
* A constant representing the object's type. For this resource it will always be
* `entity_supplemental_document`.
*/
fun type(type: Type) = type(JsonField.of(type))
/**
* A constant representing the object's type. For this resource it will always be
* `entity_supplemental_document`.
*/
@JsonProperty("type")
@ExcludeMissing
fun type(type: JsonField) = apply { this.type = type }
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
this.additionalProperties.putAll(additionalProperties)
}
@JsonAnySetter
fun putAdditionalProperty(key: String, value: JsonValue) = apply {
this.additionalProperties.put(key, value)
}
fun putAllAdditionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.putAll(additionalProperties)
}
fun build(): EntitySupplementalDocument =
EntitySupplementalDocument(
createdAt,
entityId,
fileId,
idempotencyKey,
type,
additionalProperties.toUnmodifiable(),
)
}
class Type
@JsonCreator
private constructor(
private val value: JsonField,
) : Enum {
@com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Type && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField
val ENTITY_SUPPLEMENTAL_DOCUMENT = Type(JsonField.of("entity_supplemental_document"))
@JvmStatic fun of(value: String) = Type(JsonField.of(value))
}
enum class Known {
ENTITY_SUPPLEMENTAL_DOCUMENT,
}
enum class Value {
ENTITY_SUPPLEMENTAL_DOCUMENT,
_UNKNOWN,
}
fun value(): Value =
when (this) {
ENTITY_SUPPLEMENTAL_DOCUMENT -> Value.ENTITY_SUPPLEMENTAL_DOCUMENT
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
ENTITY_SUPPLEMENTAL_DOCUMENT -> Known.ENTITY_SUPPLEMENTAL_DOCUMENT
else -> throw IncreaseInvalidDataException("Unknown Type: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}