com.increase.api.models.EntityCreateParams.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.JsonValue
import com.increase.api.core.NoAutoDetect
import com.increase.api.core.toUnmodifiable
import com.increase.api.errors.IncreaseInvalidDataException
import com.increase.api.models.*
import java.time.LocalDate
import java.util.Objects
import java.util.Optional
class EntityCreateParams
constructor(
private val structure: Structure,
private val corporation: Corporation?,
private val description: String?,
private val governmentAuthority: GovernmentAuthority?,
private val joint: Joint?,
private val naturalPerson: NaturalPerson?,
private val supplementalDocuments: List?,
private val trust: Trust?,
private val additionalQueryParams: Map>,
private val additionalHeaders: Map>,
private val additionalBodyProperties: Map,
) {
fun structure(): Structure = structure
fun corporation(): Optional = Optional.ofNullable(corporation)
fun description(): Optional = Optional.ofNullable(description)
fun governmentAuthority(): Optional =
Optional.ofNullable(governmentAuthority)
fun joint(): Optional = Optional.ofNullable(joint)
fun naturalPerson(): Optional = Optional.ofNullable(naturalPerson)
fun supplementalDocuments(): Optional> =
Optional.ofNullable(supplementalDocuments)
fun trust(): Optional = Optional.ofNullable(trust)
@JvmSynthetic
internal fun getBody(): EntityCreateBody {
return EntityCreateBody(
structure,
corporation,
description,
governmentAuthority,
joint,
naturalPerson,
supplementalDocuments,
trust,
additionalBodyProperties,
)
}
@JvmSynthetic internal fun getQueryParams(): Map> = additionalQueryParams
@JvmSynthetic internal fun getHeaders(): Map> = additionalHeaders
@JsonDeserialize(builder = EntityCreateBody.Builder::class)
@NoAutoDetect
class EntityCreateBody
internal constructor(
private val structure: Structure?,
private val corporation: Corporation?,
private val description: String?,
private val governmentAuthority: GovernmentAuthority?,
private val joint: Joint?,
private val naturalPerson: NaturalPerson?,
private val supplementalDocuments: List?,
private val trust: Trust?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The type of Entity to create. */
@JsonProperty("structure") fun structure(): Structure? = structure
/**
* Details of the corporation entity to create. Required if `structure` is equal to
* `corporation`.
*/
@JsonProperty("corporation") fun corporation(): Corporation? = corporation
/** The description you choose to give the entity. */
@JsonProperty("description") fun description(): String? = description
/**
* Details of the Government Authority entity to create. Required if `structure` is equal to
* `Government Authority`.
*/
@JsonProperty("government_authority")
fun governmentAuthority(): GovernmentAuthority? = governmentAuthority
/** Details of the joint entity to create. Required if `structure` is equal to `joint`. */
@JsonProperty("joint") fun joint(): Joint? = joint
/**
* Details of the natural person entity to create. Required if `structure` is equal to
* `natural_person`. Natural people entities should be submitted with
* `social_security_number` or `individual_taxpayer_identification_number` identification
* methods.
*/
@JsonProperty("natural_person") fun naturalPerson(): NaturalPerson? = naturalPerson
/** Additional documentation associated with the entity. */
@JsonProperty("supplemental_documents")
fun supplementalDocuments(): List? = supplementalDocuments
/** Details of the trust entity to create. Required if `structure` is equal to `trust`. */
@JsonProperty("trust") fun trust(): Trust? = trust
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is EntityCreateBody &&
this.structure == other.structure &&
this.corporation == other.corporation &&
this.description == other.description &&
this.governmentAuthority == other.governmentAuthority &&
this.joint == other.joint &&
this.naturalPerson == other.naturalPerson &&
this.supplementalDocuments == other.supplementalDocuments &&
this.trust == other.trust &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
structure,
corporation,
description,
governmentAuthority,
joint,
naturalPerson,
supplementalDocuments,
trust,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"EntityCreateBody{structure=$structure, corporation=$corporation, description=$description, governmentAuthority=$governmentAuthority, joint=$joint, naturalPerson=$naturalPerson, supplementalDocuments=$supplementalDocuments, trust=$trust, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var structure: Structure? = null
private var corporation: Corporation? = null
private var description: String? = null
private var governmentAuthority: GovernmentAuthority? = null
private var joint: Joint? = null
private var naturalPerson: NaturalPerson? = null
private var supplementalDocuments: List? = null
private var trust: Trust? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(entityCreateBody: EntityCreateBody) = apply {
this.structure = entityCreateBody.structure
this.corporation = entityCreateBody.corporation
this.description = entityCreateBody.description
this.governmentAuthority = entityCreateBody.governmentAuthority
this.joint = entityCreateBody.joint
this.naturalPerson = entityCreateBody.naturalPerson
this.supplementalDocuments = entityCreateBody.supplementalDocuments
this.trust = entityCreateBody.trust
additionalProperties(entityCreateBody.additionalProperties)
}
/** The type of Entity to create. */
@JsonProperty("structure")
fun structure(structure: Structure) = apply { this.structure = structure }
/**
* Details of the corporation entity to create. Required if `structure` is equal to
* `corporation`.
*/
@JsonProperty("corporation")
fun corporation(corporation: Corporation) = apply { this.corporation = corporation }
/** The description you choose to give the entity. */
@JsonProperty("description")
fun description(description: String) = apply { this.description = description }
/**
* Details of the Government Authority entity to create. Required if `structure` is
* equal to `Government Authority`.
*/
@JsonProperty("government_authority")
fun governmentAuthority(governmentAuthority: GovernmentAuthority) = apply {
this.governmentAuthority = governmentAuthority
}
/**
* Details of the joint entity to create. Required if `structure` is equal to `joint`.
*/
@JsonProperty("joint") fun joint(joint: Joint) = apply { this.joint = joint }
/**
* Details of the natural person entity to create. Required if `structure` is equal to
* `natural_person`. Natural people entities should be submitted with
* `social_security_number` or `individual_taxpayer_identification_number`
* identification methods.
*/
@JsonProperty("natural_person")
fun naturalPerson(naturalPerson: NaturalPerson) = apply {
this.naturalPerson = naturalPerson
}
/** Additional documentation associated with the entity. */
@JsonProperty("supplemental_documents")
fun supplementalDocuments(supplementalDocuments: List) = apply {
this.supplementalDocuments = supplementalDocuments
}
/**
* Details of the trust entity to create. Required if `structure` is equal to `trust`.
*/
@JsonProperty("trust") fun trust(trust: Trust) = apply { this.trust = trust }
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(): EntityCreateBody =
EntityCreateBody(
checkNotNull(structure) { "`structure` is required but was not set" },
corporation,
description,
governmentAuthority,
joint,
naturalPerson,
supplementalDocuments?.toUnmodifiable(),
trust,
additionalProperties.toUnmodifiable(),
)
}
}
fun _additionalQueryParams(): Map> = additionalQueryParams
fun _additionalHeaders(): Map> = additionalHeaders
fun _additionalBodyProperties(): Map = additionalBodyProperties
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is EntityCreateParams &&
this.structure == other.structure &&
this.corporation == other.corporation &&
this.description == other.description &&
this.governmentAuthority == other.governmentAuthority &&
this.joint == other.joint &&
this.naturalPerson == other.naturalPerson &&
this.supplementalDocuments == other.supplementalDocuments &&
this.trust == other.trust &&
this.additionalQueryParams == other.additionalQueryParams &&
this.additionalHeaders == other.additionalHeaders &&
this.additionalBodyProperties == other.additionalBodyProperties
}
override fun hashCode(): Int {
return Objects.hash(
structure,
corporation,
description,
governmentAuthority,
joint,
naturalPerson,
supplementalDocuments,
trust,
additionalQueryParams,
additionalHeaders,
additionalBodyProperties,
)
}
override fun toString() =
"EntityCreateParams{structure=$structure, corporation=$corporation, description=$description, governmentAuthority=$governmentAuthority, joint=$joint, naturalPerson=$naturalPerson, supplementalDocuments=$supplementalDocuments, trust=$trust, additionalQueryParams=$additionalQueryParams, additionalHeaders=$additionalHeaders, additionalBodyProperties=$additionalBodyProperties}"
fun toBuilder() = Builder().from(this)
companion object {
@JvmStatic fun builder() = Builder()
}
@NoAutoDetect
class Builder {
private var structure: Structure? = null
private var corporation: Corporation? = null
private var description: String? = null
private var governmentAuthority: GovernmentAuthority? = null
private var joint: Joint? = null
private var naturalPerson: NaturalPerson? = null
private var supplementalDocuments: MutableList = mutableListOf()
private var trust: Trust? = null
private var additionalQueryParams: MutableMap> = mutableMapOf()
private var additionalHeaders: MutableMap> = mutableMapOf()
private var additionalBodyProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(entityCreateParams: EntityCreateParams) = apply {
this.structure = entityCreateParams.structure
this.corporation = entityCreateParams.corporation
this.description = entityCreateParams.description
this.governmentAuthority = entityCreateParams.governmentAuthority
this.joint = entityCreateParams.joint
this.naturalPerson = entityCreateParams.naturalPerson
this.supplementalDocuments(entityCreateParams.supplementalDocuments ?: listOf())
this.trust = entityCreateParams.trust
additionalQueryParams(entityCreateParams.additionalQueryParams)
additionalHeaders(entityCreateParams.additionalHeaders)
additionalBodyProperties(entityCreateParams.additionalBodyProperties)
}
/** The type of Entity to create. */
fun structure(structure: Structure) = apply { this.structure = structure }
/**
* Details of the corporation entity to create. Required if `structure` is equal to
* `corporation`.
*/
fun corporation(corporation: Corporation) = apply { this.corporation = corporation }
/** The description you choose to give the entity. */
fun description(description: String) = apply { this.description = description }
/**
* Details of the Government Authority entity to create. Required if `structure` is equal to
* `Government Authority`.
*/
fun governmentAuthority(governmentAuthority: GovernmentAuthority) = apply {
this.governmentAuthority = governmentAuthority
}
/** Details of the joint entity to create. Required if `structure` is equal to `joint`. */
fun joint(joint: Joint) = apply { this.joint = joint }
/**
* Details of the natural person entity to create. Required if `structure` is equal to
* `natural_person`. Natural people entities should be submitted with
* `social_security_number` or `individual_taxpayer_identification_number` identification
* methods.
*/
fun naturalPerson(naturalPerson: NaturalPerson) = apply {
this.naturalPerson = naturalPerson
}
/** Additional documentation associated with the entity. */
fun supplementalDocuments(supplementalDocuments: List) = apply {
this.supplementalDocuments.clear()
this.supplementalDocuments.addAll(supplementalDocuments)
}
/** Additional documentation associated with the entity. */
fun addSupplementalDocument(supplementalDocument: SupplementalDocument) = apply {
this.supplementalDocuments.add(supplementalDocument)
}
/** Details of the trust entity to create. Required if `structure` is equal to `trust`. */
fun trust(trust: Trust) = apply { this.trust = trust }
fun additionalQueryParams(additionalQueryParams: Map>) = apply {
this.additionalQueryParams.clear()
putAllQueryParams(additionalQueryParams)
}
fun putQueryParam(name: String, value: String) = apply {
this.additionalQueryParams.getOrPut(name) { mutableListOf() }.add(value)
}
fun putQueryParams(name: String, values: Iterable) = apply {
this.additionalQueryParams.getOrPut(name) { mutableListOf() }.addAll(values)
}
fun putAllQueryParams(additionalQueryParams: Map>) = apply {
additionalQueryParams.forEach(this::putQueryParams)
}
fun removeQueryParam(name: String) = apply {
this.additionalQueryParams.put(name, mutableListOf())
}
fun additionalHeaders(additionalHeaders: Map>) = apply {
this.additionalHeaders.clear()
putAllHeaders(additionalHeaders)
}
fun putHeader(name: String, value: String) = apply {
this.additionalHeaders.getOrPut(name) { mutableListOf() }.add(value)
}
fun putHeaders(name: String, values: Iterable) = apply {
this.additionalHeaders.getOrPut(name) { mutableListOf() }.addAll(values)
}
fun putAllHeaders(additionalHeaders: Map>) = apply {
additionalHeaders.forEach(this::putHeaders)
}
fun removeHeader(name: String) = apply { this.additionalHeaders.put(name, mutableListOf()) }
fun additionalBodyProperties(additionalBodyProperties: Map) = apply {
this.additionalBodyProperties.clear()
this.additionalBodyProperties.putAll(additionalBodyProperties)
}
fun putAdditionalBodyProperty(key: String, value: JsonValue) = apply {
this.additionalBodyProperties.put(key, value)
}
fun putAllAdditionalBodyProperties(additionalBodyProperties: Map) =
apply {
this.additionalBodyProperties.putAll(additionalBodyProperties)
}
fun build(): EntityCreateParams =
EntityCreateParams(
checkNotNull(structure) { "`structure` is required but was not set" },
corporation,
description,
governmentAuthority,
joint,
naturalPerson,
if (supplementalDocuments.size == 0) null
else supplementalDocuments.toUnmodifiable(),
trust,
additionalQueryParams.mapValues { it.value.toUnmodifiable() }.toUnmodifiable(),
additionalHeaders.mapValues { it.value.toUnmodifiable() }.toUnmodifiable(),
additionalBodyProperties.toUnmodifiable(),
)
}
class Structure
@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 Structure && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val CORPORATION = Structure(JsonField.of("corporation"))
@JvmField val NATURAL_PERSON = Structure(JsonField.of("natural_person"))
@JvmField val JOINT = Structure(JsonField.of("joint"))
@JvmField val TRUST = Structure(JsonField.of("trust"))
@JvmField val GOVERNMENT_AUTHORITY = Structure(JsonField.of("government_authority"))
@JvmStatic fun of(value: String) = Structure(JsonField.of(value))
}
enum class Known {
CORPORATION,
NATURAL_PERSON,
JOINT,
TRUST,
GOVERNMENT_AUTHORITY,
}
enum class Value {
CORPORATION,
NATURAL_PERSON,
JOINT,
TRUST,
GOVERNMENT_AUTHORITY,
_UNKNOWN,
}
fun value(): Value =
when (this) {
CORPORATION -> Value.CORPORATION
NATURAL_PERSON -> Value.NATURAL_PERSON
JOINT -> Value.JOINT
TRUST -> Value.TRUST
GOVERNMENT_AUTHORITY -> Value.GOVERNMENT_AUTHORITY
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
CORPORATION -> Known.CORPORATION
NATURAL_PERSON -> Known.NATURAL_PERSON
JOINT -> Known.JOINT
TRUST -> Known.TRUST
GOVERNMENT_AUTHORITY -> Known.GOVERNMENT_AUTHORITY
else -> throw IncreaseInvalidDataException("Unknown Structure: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/**
* Details of the corporation entity to create. Required if `structure` is equal to
* `corporation`.
*/
@JsonDeserialize(builder = Corporation.Builder::class)
@NoAutoDetect
class Corporation
private constructor(
private val address: Address?,
private val beneficialOwners: List?,
private val incorporationState: String?,
private val industryCode: String?,
private val name: String?,
private val taxIdentifier: String?,
private val website: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The entity's physical address. Mail receiving locations like PO Boxes and PMB's are
* disallowed.
*/
@JsonProperty("address") fun address(): Address? = address
/**
* The identifying details of anyone controlling or owning 25% or more of the corporation.
*/
@JsonProperty("beneficial_owners")
fun beneficialOwners(): List? = beneficialOwners
/**
* The two-letter United States Postal Service (USPS) abbreviation for the corporation's
* state of incorporation.
*/
@JsonProperty("incorporation_state") fun incorporationState(): String? = incorporationState
/**
* The North American Industry Classification System (NAICS) code for the corporation's
* primary line of business. This is a number, like `5132` for `Software Publishers`. A full
* list of classification codes is available
* [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
*/
@JsonProperty("industry_code") fun industryCode(): String? = industryCode
/** The legal name of the corporation. */
@JsonProperty("name") fun name(): String? = name
/** The Employer Identification Number (EIN) for the corporation. */
@JsonProperty("tax_identifier") fun taxIdentifier(): String? = taxIdentifier
/** The website of the corporation. */
@JsonProperty("website") fun website(): String? = website
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Corporation &&
this.address == other.address &&
this.beneficialOwners == other.beneficialOwners &&
this.incorporationState == other.incorporationState &&
this.industryCode == other.industryCode &&
this.name == other.name &&
this.taxIdentifier == other.taxIdentifier &&
this.website == other.website &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
address,
beneficialOwners,
incorporationState,
industryCode,
name,
taxIdentifier,
website,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Corporation{address=$address, beneficialOwners=$beneficialOwners, incorporationState=$incorporationState, industryCode=$industryCode, name=$name, taxIdentifier=$taxIdentifier, website=$website, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var address: Address? = null
private var beneficialOwners: List? = null
private var incorporationState: String? = null
private var industryCode: String? = null
private var name: String? = null
private var taxIdentifier: String? = null
private var website: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(corporation: Corporation) = apply {
this.address = corporation.address
this.beneficialOwners = corporation.beneficialOwners
this.incorporationState = corporation.incorporationState
this.industryCode = corporation.industryCode
this.name = corporation.name
this.taxIdentifier = corporation.taxIdentifier
this.website = corporation.website
additionalProperties(corporation.additionalProperties)
}
/**
* The entity's physical address. Mail receiving locations like PO Boxes and PMB's are
* disallowed.
*/
@JsonProperty("address")
fun address(address: Address) = apply { this.address = address }
/**
* The identifying details of anyone controlling or owning 25% or more of the
* corporation.
*/
@JsonProperty("beneficial_owners")
fun beneficialOwners(beneficialOwners: List) = apply {
this.beneficialOwners = beneficialOwners
}
/**
* The two-letter United States Postal Service (USPS) abbreviation for the corporation's
* state of incorporation.
*/
@JsonProperty("incorporation_state")
fun incorporationState(incorporationState: String) = apply {
this.incorporationState = incorporationState
}
/**
* The North American Industry Classification System (NAICS) code for the corporation's
* primary line of business. This is a number, like `5132` for `Software Publishers`. A
* full list of classification codes is available
* [here](https://increase.com/documentation/data-dictionary#north-american-industry-classification-system-codes).
*/
@JsonProperty("industry_code")
fun industryCode(industryCode: String) = apply { this.industryCode = industryCode }
/** The legal name of the corporation. */
@JsonProperty("name") fun name(name: String) = apply { this.name = name }
/** The Employer Identification Number (EIN) for the corporation. */
@JsonProperty("tax_identifier")
fun taxIdentifier(taxIdentifier: String) = apply { this.taxIdentifier = taxIdentifier }
/** The website of the corporation. */
@JsonProperty("website") fun website(website: String) = apply { this.website = website }
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(): Corporation =
Corporation(
checkNotNull(address) { "`address` is required but was not set" },
checkNotNull(beneficialOwners) {
"`beneficialOwners` is required but was not set"
}
.toUnmodifiable(),
incorporationState,
industryCode,
checkNotNull(name) { "`name` is required but was not set" },
checkNotNull(taxIdentifier) { "`taxIdentifier` is required but was not set" },
website,
additionalProperties.toUnmodifiable(),
)
}
/**
* The entity's physical address. Mail receiving locations like PO Boxes and PMB's are
* disallowed.
*/
@JsonDeserialize(builder = Address.Builder::class)
@NoAutoDetect
class Address
private constructor(
private val city: String?,
private val line1: String?,
private val line2: String?,
private val state: String?,
private val zip: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The city of the address. */
@JsonProperty("city") fun city(): String? = city
/** The first line of the address. This is usually the street number and street. */
@JsonProperty("line1") fun line1(): String? = line1
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(): String? = line2
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state of the
* address.
*/
@JsonProperty("state") fun state(): String? = state
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(): String? = zip
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Address &&
this.city == other.city &&
this.line1 == other.line1 &&
this.line2 == other.line2 &&
this.state == other.state &&
this.zip == other.zip &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
city,
line1,
line2,
state,
zip,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Address{city=$city, line1=$line1, line2=$line2, state=$state, zip=$zip, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var city: String? = null
private var line1: String? = null
private var line2: String? = null
private var state: String? = null
private var zip: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(address: Address) = apply {
this.city = address.city
this.line1 = address.line1
this.line2 = address.line2
this.state = address.state
this.zip = address.zip
additionalProperties(address.additionalProperties)
}
/** The city of the address. */
@JsonProperty("city") fun city(city: String) = apply { this.city = city }
/** The first line of the address. This is usually the street number and street. */
@JsonProperty("line1") fun line1(line1: String) = apply { this.line1 = line1 }
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(line2: String) = apply { this.line2 = line2 }
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state of
* the address.
*/
@JsonProperty("state") fun state(state: String) = apply { this.state = state }
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(zip: String) = apply { this.zip = zip }
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(): Address =
Address(
checkNotNull(city) { "`city` is required but was not set" },
checkNotNull(line1) { "`line1` is required but was not set" },
line2,
checkNotNull(state) { "`state` is required but was not set" },
checkNotNull(zip) { "`zip` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
@JsonDeserialize(builder = BeneficialOwner.Builder::class)
@NoAutoDetect
class BeneficialOwner
private constructor(
private val companyTitle: String?,
private val individual: Individual?,
private val prongs: List?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** This person's role or title within the entity. */
@JsonProperty("company_title") fun companyTitle(): String? = companyTitle
/** Personal details for the beneficial owner. */
@JsonProperty("individual") fun individual(): Individual? = individual
/**
* Why this person is considered a beneficial owner of the entity. At least one option
* is required, if a person is both a control person and owner, submit an array
* containing both.
*/
@JsonProperty("prongs") fun prongs(): List? = prongs
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is BeneficialOwner &&
this.companyTitle == other.companyTitle &&
this.individual == other.individual &&
this.prongs == other.prongs &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
companyTitle,
individual,
prongs,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"BeneficialOwner{companyTitle=$companyTitle, individual=$individual, prongs=$prongs, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var companyTitle: String? = null
private var individual: Individual? = null
private var prongs: List? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(beneficialOwner: BeneficialOwner) = apply {
this.companyTitle = beneficialOwner.companyTitle
this.individual = beneficialOwner.individual
this.prongs = beneficialOwner.prongs
additionalProperties(beneficialOwner.additionalProperties)
}
/** This person's role or title within the entity. */
@JsonProperty("company_title")
fun companyTitle(companyTitle: String) = apply { this.companyTitle = companyTitle }
/** Personal details for the beneficial owner. */
@JsonProperty("individual")
fun individual(individual: Individual) = apply { this.individual = individual }
/**
* Why this person is considered a beneficial owner of the entity. At least one
* option is required, if a person is both a control person and owner, submit an
* array containing both.
*/
@JsonProperty("prongs")
fun prongs(prongs: List) = apply { this.prongs = prongs }
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(): BeneficialOwner =
BeneficialOwner(
companyTitle,
checkNotNull(individual) { "`individual` is required but was not set" },
checkNotNull(prongs) { "`prongs` is required but was not set" }
.toUnmodifiable(),
additionalProperties.toUnmodifiable(),
)
}
/** Personal details for the beneficial owner. */
@JsonDeserialize(builder = Individual.Builder::class)
@NoAutoDetect
class Individual
private constructor(
private val address: Address?,
private val confirmedNoUsTaxId: Boolean?,
private val dateOfBirth: LocalDate?,
private val identification: Identification?,
private val name: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The individual's physical address. Mail receiving locations like PO Boxes and
* PMB's are disallowed.
*/
@JsonProperty("address") fun address(): Address? = address
/**
* The identification method for an individual can only be a passport, driver's
* license, or other document if you've confirmed the individual does not have a US
* tax id (either a Social Security Number or Individual Taxpayer Identification
* Number).
*/
@JsonProperty("confirmed_no_us_tax_id")
fun confirmedNoUsTaxId(): Boolean? = confirmedNoUsTaxId
/** The person's date of birth in YYYY-MM-DD format. */
@JsonProperty("date_of_birth") fun dateOfBirth(): LocalDate? = dateOfBirth
/** A means of verifying the person's identity. */
@JsonProperty("identification")
fun identification(): Identification? = identification
/** The person's legal name. */
@JsonProperty("name") fun name(): String? = name
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Individual &&
this.address == other.address &&
this.confirmedNoUsTaxId == other.confirmedNoUsTaxId &&
this.dateOfBirth == other.dateOfBirth &&
this.identification == other.identification &&
this.name == other.name &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
address,
confirmedNoUsTaxId,
dateOfBirth,
identification,
name,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Individual{address=$address, confirmedNoUsTaxId=$confirmedNoUsTaxId, dateOfBirth=$dateOfBirth, identification=$identification, name=$name, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var address: Address? = null
private var confirmedNoUsTaxId: Boolean? = null
private var dateOfBirth: LocalDate? = null
private var identification: Identification? = null
private var name: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(individual: Individual) = apply {
this.address = individual.address
this.confirmedNoUsTaxId = individual.confirmedNoUsTaxId
this.dateOfBirth = individual.dateOfBirth
this.identification = individual.identification
this.name = individual.name
additionalProperties(individual.additionalProperties)
}
/**
* The individual's physical address. Mail receiving locations like PO Boxes and
* PMB's are disallowed.
*/
@JsonProperty("address")
fun address(address: Address) = apply { this.address = address }
/**
* The identification method for an individual can only be a passport, driver's
* license, or other document if you've confirmed the individual does not have a
* US tax id (either a Social Security Number or Individual Taxpayer
* Identification Number).
*/
@JsonProperty("confirmed_no_us_tax_id")
fun confirmedNoUsTaxId(confirmedNoUsTaxId: Boolean) = apply {
this.confirmedNoUsTaxId = confirmedNoUsTaxId
}
/** The person's date of birth in YYYY-MM-DD format. */
@JsonProperty("date_of_birth")
fun dateOfBirth(dateOfBirth: LocalDate) = apply {
this.dateOfBirth = dateOfBirth
}
/** A means of verifying the person's identity. */
@JsonProperty("identification")
fun identification(identification: Identification) = apply {
this.identification = identification
}
/** The person's legal name. */
@JsonProperty("name") fun name(name: String) = apply { this.name = name }
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(): Individual =
Individual(
checkNotNull(address) { "`address` is required but was not set" },
confirmedNoUsTaxId,
checkNotNull(dateOfBirth) {
"`dateOfBirth` is required but was not set"
},
checkNotNull(identification) {
"`identification` is required but was not set"
},
checkNotNull(name) { "`name` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
/**
* The individual's physical address. Mail receiving locations like PO Boxes and
* PMB's are disallowed.
*/
@JsonDeserialize(builder = Address.Builder::class)
@NoAutoDetect
class Address
private constructor(
private val city: String?,
private val line1: String?,
private val line2: String?,
private val state: String?,
private val zip: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The city of the address. */
@JsonProperty("city") fun city(): String? = city
/**
* The first line of the address. This is usually the street number and street.
*/
@JsonProperty("line1") fun line1(): String? = line1
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(): String? = line2
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state
* of the address.
*/
@JsonProperty("state") fun state(): String? = state
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(): String? = zip
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Address &&
this.city == other.city &&
this.line1 == other.line1 &&
this.line2 == other.line2 &&
this.state == other.state &&
this.zip == other.zip &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
city,
line1,
line2,
state,
zip,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Address{city=$city, line1=$line1, line2=$line2, state=$state, zip=$zip, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var city: String? = null
private var line1: String? = null
private var line2: String? = null
private var state: String? = null
private var zip: String? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(address: Address) = apply {
this.city = address.city
this.line1 = address.line1
this.line2 = address.line2
this.state = address.state
this.zip = address.zip
additionalProperties(address.additionalProperties)
}
/** The city of the address. */
@JsonProperty("city") fun city(city: String) = apply { this.city = city }
/**
* The first line of the address. This is usually the street number and
* street.
*/
@JsonProperty("line1")
fun line1(line1: String) = apply { this.line1 = line1 }
/**
* The second line of the address. This might be the floor or room number.
*/
@JsonProperty("line2")
fun line2(line2: String) = apply { this.line2 = line2 }
/**
* The two-letter United States Postal Service (USPS) abbreviation for the
* state of the address.
*/
@JsonProperty("state")
fun state(state: String) = apply { this.state = state }
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(zip: String) = apply { this.zip = zip }
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(): Address =
Address(
checkNotNull(city) { "`city` is required but was not set" },
checkNotNull(line1) { "`line1` is required but was not set" },
line2,
checkNotNull(state) { "`state` is required but was not set" },
checkNotNull(zip) { "`zip` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/** A means of verifying the person's identity. */
@JsonDeserialize(builder = Identification.Builder::class)
@NoAutoDetect
class Identification
private constructor(
private val driversLicense: DriversLicense?,
private val method: Method?,
private val number: String?,
private val other: Other?,
private val passport: Passport?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* Information about the United States driver's license used for identification.
* Required if `method` is equal to `drivers_license`.
*/
@JsonProperty("drivers_license")
fun driversLicense(): DriversLicense? = driversLicense
/** A method that can be used to verify the individual's identity. */
@JsonProperty("method") fun method(): Method? = method
/**
* An identification number that can be used to verify the individual's
* identity, such as a social security number.
*/
@JsonProperty("number") fun number(): String? = number
/**
* Information about the identification document provided. Required if `method`
* is equal to `other`.
*/
@JsonProperty("other") fun other(): Other? = other
/**
* Information about the passport used for identification. Required if `method`
* is equal to `passport`.
*/
@JsonProperty("passport") fun passport(): Passport? = passport
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Identification &&
this.driversLicense == other.driversLicense &&
this.method == other.method &&
this.number == other.number &&
this.other == other.other &&
this.passport == other.passport &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
driversLicense,
method,
number,
other,
passport,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Identification{driversLicense=$driversLicense, method=$method, number=$number, other=$other, passport=$passport, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var driversLicense: DriversLicense? = null
private var method: Method? = null
private var number: String? = null
private var other: Other? = null
private var passport: Passport? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(identification: Identification) = apply {
this.driversLicense = identification.driversLicense
this.method = identification.method
this.number = identification.number
this.other = identification.other
this.passport = identification.passport
additionalProperties(identification.additionalProperties)
}
/**
* Information about the United States driver's license used for
* identification. Required if `method` is equal to `drivers_license`.
*/
@JsonProperty("drivers_license")
fun driversLicense(driversLicense: DriversLicense) = apply {
this.driversLicense = driversLicense
}
/** A method that can be used to verify the individual's identity. */
@JsonProperty("method")
fun method(method: Method) = apply { this.method = method }
/**
* An identification number that can be used to verify the individual's
* identity, such as a social security number.
*/
@JsonProperty("number")
fun number(number: String) = apply { this.number = number }
/**
* Information about the identification document provided. Required if
* `method` is equal to `other`.
*/
@JsonProperty("other")
fun other(other: Other) = apply { this.other = other }
/**
* Information about the passport used for identification. Required if
* `method` is equal to `passport`.
*/
@JsonProperty("passport")
fun passport(passport: Passport) = apply { this.passport = passport }
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(): Identification =
Identification(
driversLicense,
checkNotNull(method) { "`method` is required but was not set" },
checkNotNull(number) { "`number` is required but was not set" },
other,
passport,
additionalProperties.toUnmodifiable(),
)
}
class Method
@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 Method && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField
val SOCIAL_SECURITY_NUMBER =
Method(JsonField.of("social_security_number"))
@JvmField
val INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
Method(JsonField.of("individual_taxpayer_identification_number"))
@JvmField val PASSPORT = Method(JsonField.of("passport"))
@JvmField val DRIVERS_LICENSE = Method(JsonField.of("drivers_license"))
@JvmField val OTHER = Method(JsonField.of("other"))
@JvmStatic fun of(value: String) = Method(JsonField.of(value))
}
enum class Known {
SOCIAL_SECURITY_NUMBER,
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER,
PASSPORT,
DRIVERS_LICENSE,
OTHER,
}
enum class Value {
SOCIAL_SECURITY_NUMBER,
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER,
PASSPORT,
DRIVERS_LICENSE,
OTHER,
_UNKNOWN,
}
fun value(): Value =
when (this) {
SOCIAL_SECURITY_NUMBER -> Value.SOCIAL_SECURITY_NUMBER
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER ->
Value.INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER
PASSPORT -> Value.PASSPORT
DRIVERS_LICENSE -> Value.DRIVERS_LICENSE
OTHER -> Value.OTHER
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
SOCIAL_SECURITY_NUMBER -> Known.SOCIAL_SECURITY_NUMBER
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER ->
Known.INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER
PASSPORT -> Known.PASSPORT
DRIVERS_LICENSE -> Known.DRIVERS_LICENSE
OTHER -> Known.OTHER
else -> throw IncreaseInvalidDataException("Unknown Method: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/**
* Information about the United States driver's license used for identification.
* Required if `method` is equal to `drivers_license`.
*/
@JsonDeserialize(builder = DriversLicense.Builder::class)
@NoAutoDetect
class DriversLicense
private constructor(
private val backFileId: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val state: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The identifier of the File containing the back of the driver's license.
*/
@JsonProperty("back_file_id") fun backFileId(): String? = backFileId
/** The driver's license's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(): LocalDate? = expirationDate
/**
* The identifier of the File containing the front of the driver's license.
*/
@JsonProperty("file_id") fun fileId(): String? = fileId
/** The state that issued the provided driver's license. */
@JsonProperty("state") fun state(): String? = state
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is DriversLicense &&
this.backFileId == other.backFileId &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.state == other.state &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
backFileId,
expirationDate,
fileId,
state,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"DriversLicense{backFileId=$backFileId, expirationDate=$expirationDate, fileId=$fileId, state=$state, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var backFileId: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var state: String? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(driversLicense: DriversLicense) = apply {
this.backFileId = driversLicense.backFileId
this.expirationDate = driversLicense.expirationDate
this.fileId = driversLicense.fileId
this.state = driversLicense.state
additionalProperties(driversLicense.additionalProperties)
}
/**
* The identifier of the File containing the back of the driver's
* license.
*/
@JsonProperty("back_file_id")
fun backFileId(backFileId: String) = apply {
this.backFileId = backFileId
}
/** The driver's license's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/**
* The identifier of the File containing the front of the driver's
* license.
*/
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
/** The state that issued the provided driver's license. */
@JsonProperty("state")
fun state(state: String) = apply { this.state = state }
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(): DriversLicense =
DriversLicense(
backFileId,
checkNotNull(expirationDate) {
"`expirationDate` is required but was not set"
},
checkNotNull(fileId) { "`fileId` is required but was not set" },
checkNotNull(state) { "`state` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/**
* Information about the identification document provided. Required if `method`
* is equal to `other`.
*/
@JsonDeserialize(builder = Other.Builder::class)
@NoAutoDetect
class Other
private constructor(
private val backFileId: String?,
private val country: String?,
private val description: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The identifier of the File containing the back of the document. Not every
* document has a reverse side.
*/
@JsonProperty("back_file_id") fun backFileId(): String? = backFileId
/**
* The two-character ISO 3166-1 code representing the country that issued
* the document.
*/
@JsonProperty("country") fun country(): String? = country
/** A description of the document submitted. */
@JsonProperty("description") fun description(): String? = description
/** The document's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(): LocalDate? = expirationDate
/** The identifier of the File containing the front of the document. */
@JsonProperty("file_id") fun fileId(): String? = fileId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Other &&
this.backFileId == other.backFileId &&
this.country == other.country &&
this.description == other.description &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
backFileId,
country,
description,
expirationDate,
fileId,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Other{backFileId=$backFileId, country=$country, description=$description, expirationDate=$expirationDate, fileId=$fileId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var backFileId: String? = null
private var country: String? = null
private var description: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(other: Other) = apply {
this.backFileId = other.backFileId
this.country = other.country
this.description = other.description
this.expirationDate = other.expirationDate
this.fileId = other.fileId
additionalProperties(other.additionalProperties)
}
/**
* The identifier of the File containing the back of the document. Not
* every document has a reverse side.
*/
@JsonProperty("back_file_id")
fun backFileId(backFileId: String) = apply {
this.backFileId = backFileId
}
/**
* The two-character ISO 3166-1 code representing the country that
* issued the document.
*/
@JsonProperty("country")
fun country(country: String) = apply { this.country = country }
/** A description of the document submitted. */
@JsonProperty("description")
fun description(description: String) = apply {
this.description = description
}
/** The document's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/** The identifier of the File containing the front of the document. */
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
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(): Other =
Other(
backFileId,
checkNotNull(country) {
"`country` is required but was not set"
},
checkNotNull(description) {
"`description` is required but was not set"
},
expirationDate,
checkNotNull(fileId) { "`fileId` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/**
* Information about the passport used for identification. Required if `method`
* is equal to `passport`.
*/
@JsonDeserialize(builder = Passport.Builder::class)
@NoAutoDetect
class Passport
private constructor(
private val country: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The country that issued the passport. */
@JsonProperty("country") fun country(): String? = country
/** The passport's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(): LocalDate? = expirationDate
/** The identifier of the File containing the passport. */
@JsonProperty("file_id") fun fileId(): String? = fileId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Passport &&
this.country == other.country &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
country,
expirationDate,
fileId,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Passport{country=$country, expirationDate=$expirationDate, fileId=$fileId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var country: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(passport: Passport) = apply {
this.country = passport.country
this.expirationDate = passport.expirationDate
this.fileId = passport.fileId
additionalProperties(passport.additionalProperties)
}
/** The country that issued the passport. */
@JsonProperty("country")
fun country(country: String) = apply { this.country = country }
/** The passport's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/** The identifier of the File containing the passport. */
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
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(): Passport =
Passport(
checkNotNull(country) {
"`country` is required but was not set"
},
checkNotNull(expirationDate) {
"`expirationDate` is required but was not set"
},
checkNotNull(fileId) { "`fileId` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
}
}
class Prong
@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 Prong && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val OWNERSHIP = Prong(JsonField.of("ownership"))
@JvmField val CONTROL = Prong(JsonField.of("control"))
@JvmStatic fun of(value: String) = Prong(JsonField.of(value))
}
enum class Known {
OWNERSHIP,
CONTROL,
}
enum class Value {
OWNERSHIP,
CONTROL,
_UNKNOWN,
}
fun value(): Value =
when (this) {
OWNERSHIP -> Value.OWNERSHIP
CONTROL -> Value.CONTROL
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
OWNERSHIP -> Known.OWNERSHIP
CONTROL -> Known.CONTROL
else -> throw IncreaseInvalidDataException("Unknown Prong: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}
}
/**
* Details of the Government Authority entity to create. Required if `structure` is equal to
* `Government Authority`.
*/
@JsonDeserialize(builder = GovernmentAuthority.Builder::class)
@NoAutoDetect
class GovernmentAuthority
private constructor(
private val address: Address?,
private val authorizedPersons: List?,
private val category: Category?,
private val name: String?,
private val taxIdentifier: String?,
private val website: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The entity's physical address. Mail receiving locations like PO Boxes and PMB's are
* disallowed.
*/
@JsonProperty("address") fun address(): Address? = address
/** The identifying details of authorized officials acting on the entity's behalf. */
@JsonProperty("authorized_persons")
fun authorizedPersons(): List? = authorizedPersons
/** The category of the government authority. */
@JsonProperty("category") fun category(): Category? = category
/** The legal name of the government authority. */
@JsonProperty("name") fun name(): String? = name
/** The Employer Identification Number (EIN) for the government authority. */
@JsonProperty("tax_identifier") fun taxIdentifier(): String? = taxIdentifier
/** The website of the government authority. */
@JsonProperty("website") fun website(): String? = website
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is GovernmentAuthority &&
this.address == other.address &&
this.authorizedPersons == other.authorizedPersons &&
this.category == other.category &&
this.name == other.name &&
this.taxIdentifier == other.taxIdentifier &&
this.website == other.website &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
address,
authorizedPersons,
category,
name,
taxIdentifier,
website,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"GovernmentAuthority{address=$address, authorizedPersons=$authorizedPersons, category=$category, name=$name, taxIdentifier=$taxIdentifier, website=$website, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var address: Address? = null
private var authorizedPersons: List? = null
private var category: Category? = null
private var name: String? = null
private var taxIdentifier: String? = null
private var website: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(governmentAuthority: GovernmentAuthority) = apply {
this.address = governmentAuthority.address
this.authorizedPersons = governmentAuthority.authorizedPersons
this.category = governmentAuthority.category
this.name = governmentAuthority.name
this.taxIdentifier = governmentAuthority.taxIdentifier
this.website = governmentAuthority.website
additionalProperties(governmentAuthority.additionalProperties)
}
/**
* The entity's physical address. Mail receiving locations like PO Boxes and PMB's are
* disallowed.
*/
@JsonProperty("address")
fun address(address: Address) = apply { this.address = address }
/** The identifying details of authorized officials acting on the entity's behalf. */
@JsonProperty("authorized_persons")
fun authorizedPersons(authorizedPersons: List) = apply {
this.authorizedPersons = authorizedPersons
}
/** The category of the government authority. */
@JsonProperty("category")
fun category(category: Category) = apply { this.category = category }
/** The legal name of the government authority. */
@JsonProperty("name") fun name(name: String) = apply { this.name = name }
/** The Employer Identification Number (EIN) for the government authority. */
@JsonProperty("tax_identifier")
fun taxIdentifier(taxIdentifier: String) = apply { this.taxIdentifier = taxIdentifier }
/** The website of the government authority. */
@JsonProperty("website") fun website(website: String) = apply { this.website = website }
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(): GovernmentAuthority =
GovernmentAuthority(
checkNotNull(address) { "`address` is required but was not set" },
checkNotNull(authorizedPersons) {
"`authorizedPersons` is required but was not set"
}
.toUnmodifiable(),
checkNotNull(category) { "`category` is required but was not set" },
checkNotNull(name) { "`name` is required but was not set" },
checkNotNull(taxIdentifier) { "`taxIdentifier` is required but was not set" },
website,
additionalProperties.toUnmodifiable(),
)
}
/**
* The entity's physical address. Mail receiving locations like PO Boxes and PMB's are
* disallowed.
*/
@JsonDeserialize(builder = Address.Builder::class)
@NoAutoDetect
class Address
private constructor(
private val city: String?,
private val line1: String?,
private val line2: String?,
private val state: String?,
private val zip: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The city of the address. */
@JsonProperty("city") fun city(): String? = city
/** The first line of the address. This is usually the street number and street. */
@JsonProperty("line1") fun line1(): String? = line1
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(): String? = line2
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state of the
* address.
*/
@JsonProperty("state") fun state(): String? = state
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(): String? = zip
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Address &&
this.city == other.city &&
this.line1 == other.line1 &&
this.line2 == other.line2 &&
this.state == other.state &&
this.zip == other.zip &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
city,
line1,
line2,
state,
zip,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Address{city=$city, line1=$line1, line2=$line2, state=$state, zip=$zip, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var city: String? = null
private var line1: String? = null
private var line2: String? = null
private var state: String? = null
private var zip: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(address: Address) = apply {
this.city = address.city
this.line1 = address.line1
this.line2 = address.line2
this.state = address.state
this.zip = address.zip
additionalProperties(address.additionalProperties)
}
/** The city of the address. */
@JsonProperty("city") fun city(city: String) = apply { this.city = city }
/** The first line of the address. This is usually the street number and street. */
@JsonProperty("line1") fun line1(line1: String) = apply { this.line1 = line1 }
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(line2: String) = apply { this.line2 = line2 }
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state of
* the address.
*/
@JsonProperty("state") fun state(state: String) = apply { this.state = state }
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(zip: String) = apply { this.zip = zip }
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(): Address =
Address(
checkNotNull(city) { "`city` is required but was not set" },
checkNotNull(line1) { "`line1` is required but was not set" },
line2,
checkNotNull(state) { "`state` is required but was not set" },
checkNotNull(zip) { "`zip` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
@JsonDeserialize(builder = AuthorizedPerson.Builder::class)
@NoAutoDetect
class AuthorizedPerson
private constructor(
private val name: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The person's legal name. */
@JsonProperty("name") fun name(): String? = name
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is AuthorizedPerson &&
this.name == other.name &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = Objects.hash(name, additionalProperties)
}
return hashCode
}
override fun toString() =
"AuthorizedPerson{name=$name, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var name: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(authorizedPerson: AuthorizedPerson) = apply {
this.name = authorizedPerson.name
additionalProperties(authorizedPerson.additionalProperties)
}
/** The person's legal name. */
@JsonProperty("name") fun name(name: String) = apply { this.name = name }
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(): AuthorizedPerson =
AuthorizedPerson(
checkNotNull(name) { "`name` is required but was not set" },
additionalProperties.toUnmodifiable()
)
}
}
class Category
@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 Category && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val MUNICIPALITY = Category(JsonField.of("municipality"))
@JvmStatic fun of(value: String) = Category(JsonField.of(value))
}
enum class Known {
MUNICIPALITY,
}
enum class Value {
MUNICIPALITY,
_UNKNOWN,
}
fun value(): Value =
when (this) {
MUNICIPALITY -> Value.MUNICIPALITY
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
MUNICIPALITY -> Known.MUNICIPALITY
else -> throw IncreaseInvalidDataException("Unknown Category: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
}
/** Details of the joint entity to create. Required if `structure` is equal to `joint`. */
@JsonDeserialize(builder = Joint.Builder::class)
@NoAutoDetect
class Joint
private constructor(
private val individuals: List?,
private val name: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The two individuals that share control of the entity. */
@JsonProperty("individuals") fun individuals(): List? = individuals
/** The name of the joint entity. */
@JsonProperty("name") fun name(): String? = name
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Joint &&
this.individuals == other.individuals &&
this.name == other.name &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
individuals,
name,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Joint{individuals=$individuals, name=$name, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var individuals: List? = null
private var name: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(joint: Joint) = apply {
this.individuals = joint.individuals
this.name = joint.name
additionalProperties(joint.additionalProperties)
}
/** The two individuals that share control of the entity. */
@JsonProperty("individuals")
fun individuals(individuals: List) = apply {
this.individuals = individuals
}
/** The name of the joint entity. */
@JsonProperty("name") fun name(name: String) = apply { this.name = name }
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(): Joint =
Joint(
checkNotNull(individuals) { "`individuals` is required but was not set" }
.toUnmodifiable(),
name,
additionalProperties.toUnmodifiable(),
)
}
@JsonDeserialize(builder = Individual.Builder::class)
@NoAutoDetect
class Individual
private constructor(
private val address: Address?,
private val confirmedNoUsTaxId: Boolean?,
private val dateOfBirth: LocalDate?,
private val identification: Identification?,
private val name: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The individual's physical address. Mail receiving locations like PO Boxes and PMB's
* are disallowed.
*/
@JsonProperty("address") fun address(): Address? = address
/**
* The identification method for an individual can only be a passport, driver's license,
* or other document if you've confirmed the individual does not have a US tax id
* (either a Social Security Number or Individual Taxpayer Identification Number).
*/
@JsonProperty("confirmed_no_us_tax_id")
fun confirmedNoUsTaxId(): Boolean? = confirmedNoUsTaxId
/** The person's date of birth in YYYY-MM-DD format. */
@JsonProperty("date_of_birth") fun dateOfBirth(): LocalDate? = dateOfBirth
/** A means of verifying the person's identity. */
@JsonProperty("identification") fun identification(): Identification? = identification
/** The person's legal name. */
@JsonProperty("name") fun name(): String? = name
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Individual &&
this.address == other.address &&
this.confirmedNoUsTaxId == other.confirmedNoUsTaxId &&
this.dateOfBirth == other.dateOfBirth &&
this.identification == other.identification &&
this.name == other.name &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
address,
confirmedNoUsTaxId,
dateOfBirth,
identification,
name,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Individual{address=$address, confirmedNoUsTaxId=$confirmedNoUsTaxId, dateOfBirth=$dateOfBirth, identification=$identification, name=$name, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var address: Address? = null
private var confirmedNoUsTaxId: Boolean? = null
private var dateOfBirth: LocalDate? = null
private var identification: Identification? = null
private var name: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(individual: Individual) = apply {
this.address = individual.address
this.confirmedNoUsTaxId = individual.confirmedNoUsTaxId
this.dateOfBirth = individual.dateOfBirth
this.identification = individual.identification
this.name = individual.name
additionalProperties(individual.additionalProperties)
}
/**
* The individual's physical address. Mail receiving locations like PO Boxes and
* PMB's are disallowed.
*/
@JsonProperty("address")
fun address(address: Address) = apply { this.address = address }
/**
* The identification method for an individual can only be a passport, driver's
* license, or other document if you've confirmed the individual does not have a US
* tax id (either a Social Security Number or Individual Taxpayer Identification
* Number).
*/
@JsonProperty("confirmed_no_us_tax_id")
fun confirmedNoUsTaxId(confirmedNoUsTaxId: Boolean) = apply {
this.confirmedNoUsTaxId = confirmedNoUsTaxId
}
/** The person's date of birth in YYYY-MM-DD format. */
@JsonProperty("date_of_birth")
fun dateOfBirth(dateOfBirth: LocalDate) = apply { this.dateOfBirth = dateOfBirth }
/** A means of verifying the person's identity. */
@JsonProperty("identification")
fun identification(identification: Identification) = apply {
this.identification = identification
}
/** The person's legal name. */
@JsonProperty("name") fun name(name: String) = apply { this.name = name }
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(): Individual =
Individual(
checkNotNull(address) { "`address` is required but was not set" },
confirmedNoUsTaxId,
checkNotNull(dateOfBirth) { "`dateOfBirth` is required but was not set" },
checkNotNull(identification) {
"`identification` is required but was not set"
},
checkNotNull(name) { "`name` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
/**
* The individual's physical address. Mail receiving locations like PO Boxes and PMB's
* are disallowed.
*/
@JsonDeserialize(builder = Address.Builder::class)
@NoAutoDetect
class Address
private constructor(
private val city: String?,
private val line1: String?,
private val line2: String?,
private val state: String?,
private val zip: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The city of the address. */
@JsonProperty("city") fun city(): String? = city
/** The first line of the address. This is usually the street number and street. */
@JsonProperty("line1") fun line1(): String? = line1
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(): String? = line2
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state of
* the address.
*/
@JsonProperty("state") fun state(): String? = state
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(): String? = zip
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Address &&
this.city == other.city &&
this.line1 == other.line1 &&
this.line2 == other.line2 &&
this.state == other.state &&
this.zip == other.zip &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
city,
line1,
line2,
state,
zip,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Address{city=$city, line1=$line1, line2=$line2, state=$state, zip=$zip, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var city: String? = null
private var line1: String? = null
private var line2: String? = null
private var state: String? = null
private var zip: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(address: Address) = apply {
this.city = address.city
this.line1 = address.line1
this.line2 = address.line2
this.state = address.state
this.zip = address.zip
additionalProperties(address.additionalProperties)
}
/** The city of the address. */
@JsonProperty("city") fun city(city: String) = apply { this.city = city }
/**
* The first line of the address. This is usually the street number and street.
*/
@JsonProperty("line1") fun line1(line1: String) = apply { this.line1 = line1 }
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(line2: String) = apply { this.line2 = line2 }
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state
* of the address.
*/
@JsonProperty("state") fun state(state: String) = apply { this.state = state }
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(zip: String) = apply { this.zip = zip }
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(): Address =
Address(
checkNotNull(city) { "`city` is required but was not set" },
checkNotNull(line1) { "`line1` is required but was not set" },
line2,
checkNotNull(state) { "`state` is required but was not set" },
checkNotNull(zip) { "`zip` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/** A means of verifying the person's identity. */
@JsonDeserialize(builder = Identification.Builder::class)
@NoAutoDetect
class Identification
private constructor(
private val driversLicense: DriversLicense?,
private val method: Method?,
private val number: String?,
private val other: Other?,
private val passport: Passport?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* Information about the United States driver's license used for identification.
* Required if `method` is equal to `drivers_license`.
*/
@JsonProperty("drivers_license")
fun driversLicense(): DriversLicense? = driversLicense
/** A method that can be used to verify the individual's identity. */
@JsonProperty("method") fun method(): Method? = method
/**
* An identification number that can be used to verify the individual's identity,
* such as a social security number.
*/
@JsonProperty("number") fun number(): String? = number
/**
* Information about the identification document provided. Required if `method` is
* equal to `other`.
*/
@JsonProperty("other") fun other(): Other? = other
/**
* Information about the passport used for identification. Required if `method` is
* equal to `passport`.
*/
@JsonProperty("passport") fun passport(): Passport? = passport
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Identification &&
this.driversLicense == other.driversLicense &&
this.method == other.method &&
this.number == other.number &&
this.other == other.other &&
this.passport == other.passport &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
driversLicense,
method,
number,
other,
passport,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Identification{driversLicense=$driversLicense, method=$method, number=$number, other=$other, passport=$passport, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var driversLicense: DriversLicense? = null
private var method: Method? = null
private var number: String? = null
private var other: Other? = null
private var passport: Passport? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(identification: Identification) = apply {
this.driversLicense = identification.driversLicense
this.method = identification.method
this.number = identification.number
this.other = identification.other
this.passport = identification.passport
additionalProperties(identification.additionalProperties)
}
/**
* Information about the United States driver's license used for identification.
* Required if `method` is equal to `drivers_license`.
*/
@JsonProperty("drivers_license")
fun driversLicense(driversLicense: DriversLicense) = apply {
this.driversLicense = driversLicense
}
/** A method that can be used to verify the individual's identity. */
@JsonProperty("method")
fun method(method: Method) = apply { this.method = method }
/**
* An identification number that can be used to verify the individual's
* identity, such as a social security number.
*/
@JsonProperty("number")
fun number(number: String) = apply { this.number = number }
/**
* Information about the identification document provided. Required if `method`
* is equal to `other`.
*/
@JsonProperty("other") fun other(other: Other) = apply { this.other = other }
/**
* Information about the passport used for identification. Required if `method`
* is equal to `passport`.
*/
@JsonProperty("passport")
fun passport(passport: Passport) = apply { this.passport = passport }
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(): Identification =
Identification(
driversLicense,
checkNotNull(method) { "`method` is required but was not set" },
checkNotNull(number) { "`number` is required but was not set" },
other,
passport,
additionalProperties.toUnmodifiable(),
)
}
class Method
@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 Method && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField
val SOCIAL_SECURITY_NUMBER = Method(JsonField.of("social_security_number"))
@JvmField
val INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
Method(JsonField.of("individual_taxpayer_identification_number"))
@JvmField val PASSPORT = Method(JsonField.of("passport"))
@JvmField val DRIVERS_LICENSE = Method(JsonField.of("drivers_license"))
@JvmField val OTHER = Method(JsonField.of("other"))
@JvmStatic fun of(value: String) = Method(JsonField.of(value))
}
enum class Known {
SOCIAL_SECURITY_NUMBER,
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER,
PASSPORT,
DRIVERS_LICENSE,
OTHER,
}
enum class Value {
SOCIAL_SECURITY_NUMBER,
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER,
PASSPORT,
DRIVERS_LICENSE,
OTHER,
_UNKNOWN,
}
fun value(): Value =
when (this) {
SOCIAL_SECURITY_NUMBER -> Value.SOCIAL_SECURITY_NUMBER
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER ->
Value.INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER
PASSPORT -> Value.PASSPORT
DRIVERS_LICENSE -> Value.DRIVERS_LICENSE
OTHER -> Value.OTHER
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
SOCIAL_SECURITY_NUMBER -> Known.SOCIAL_SECURITY_NUMBER
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER ->
Known.INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER
PASSPORT -> Known.PASSPORT
DRIVERS_LICENSE -> Known.DRIVERS_LICENSE
OTHER -> Known.OTHER
else -> throw IncreaseInvalidDataException("Unknown Method: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/**
* Information about the United States driver's license used for identification.
* Required if `method` is equal to `drivers_license`.
*/
@JsonDeserialize(builder = DriversLicense.Builder::class)
@NoAutoDetect
class DriversLicense
private constructor(
private val backFileId: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val state: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The identifier of the File containing the back of the driver's license. */
@JsonProperty("back_file_id") fun backFileId(): String? = backFileId
/** The driver's license's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(): LocalDate? = expirationDate
/** The identifier of the File containing the front of the driver's license. */
@JsonProperty("file_id") fun fileId(): String? = fileId
/** The state that issued the provided driver's license. */
@JsonProperty("state") fun state(): String? = state
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is DriversLicense &&
this.backFileId == other.backFileId &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.state == other.state &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
backFileId,
expirationDate,
fileId,
state,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"DriversLicense{backFileId=$backFileId, expirationDate=$expirationDate, fileId=$fileId, state=$state, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var backFileId: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var state: String? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(driversLicense: DriversLicense) = apply {
this.backFileId = driversLicense.backFileId
this.expirationDate = driversLicense.expirationDate
this.fileId = driversLicense.fileId
this.state = driversLicense.state
additionalProperties(driversLicense.additionalProperties)
}
/**
* The identifier of the File containing the back of the driver's license.
*/
@JsonProperty("back_file_id")
fun backFileId(backFileId: String) = apply { this.backFileId = backFileId }
/** The driver's license's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/**
* The identifier of the File containing the front of the driver's license.
*/
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
/** The state that issued the provided driver's license. */
@JsonProperty("state")
fun state(state: String) = apply { this.state = state }
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(): DriversLicense =
DriversLicense(
backFileId,
checkNotNull(expirationDate) {
"`expirationDate` is required but was not set"
},
checkNotNull(fileId) { "`fileId` is required but was not set" },
checkNotNull(state) { "`state` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/**
* Information about the identification document provided. Required if `method` is
* equal to `other`.
*/
@JsonDeserialize(builder = Other.Builder::class)
@NoAutoDetect
class Other
private constructor(
private val backFileId: String?,
private val country: String?,
private val description: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The identifier of the File containing the back of the document. Not every
* document has a reverse side.
*/
@JsonProperty("back_file_id") fun backFileId(): String? = backFileId
/**
* The two-character ISO 3166-1 code representing the country that issued the
* document.
*/
@JsonProperty("country") fun country(): String? = country
/** A description of the document submitted. */
@JsonProperty("description") fun description(): String? = description
/** The document's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(): LocalDate? = expirationDate
/** The identifier of the File containing the front of the document. */
@JsonProperty("file_id") fun fileId(): String? = fileId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Other &&
this.backFileId == other.backFileId &&
this.country == other.country &&
this.description == other.description &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
backFileId,
country,
description,
expirationDate,
fileId,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Other{backFileId=$backFileId, country=$country, description=$description, expirationDate=$expirationDate, fileId=$fileId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var backFileId: String? = null
private var country: String? = null
private var description: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(other: Other) = apply {
this.backFileId = other.backFileId
this.country = other.country
this.description = other.description
this.expirationDate = other.expirationDate
this.fileId = other.fileId
additionalProperties(other.additionalProperties)
}
/**
* The identifier of the File containing the back of the document. Not every
* document has a reverse side.
*/
@JsonProperty("back_file_id")
fun backFileId(backFileId: String) = apply { this.backFileId = backFileId }
/**
* The two-character ISO 3166-1 code representing the country that issued
* the document.
*/
@JsonProperty("country")
fun country(country: String) = apply { this.country = country }
/** A description of the document submitted. */
@JsonProperty("description")
fun description(description: String) = apply {
this.description = description
}
/** The document's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/** The identifier of the File containing the front of the document. */
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
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(): Other =
Other(
backFileId,
checkNotNull(country) { "`country` is required but was not set" },
checkNotNull(description) {
"`description` is required but was not set"
},
expirationDate,
checkNotNull(fileId) { "`fileId` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/**
* Information about the passport used for identification. Required if `method` is
* equal to `passport`.
*/
@JsonDeserialize(builder = Passport.Builder::class)
@NoAutoDetect
class Passport
private constructor(
private val country: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The country that issued the passport. */
@JsonProperty("country") fun country(): String? = country
/** The passport's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(): LocalDate? = expirationDate
/** The identifier of the File containing the passport. */
@JsonProperty("file_id") fun fileId(): String? = fileId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Passport &&
this.country == other.country &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
country,
expirationDate,
fileId,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Passport{country=$country, expirationDate=$expirationDate, fileId=$fileId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var country: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(passport: Passport) = apply {
this.country = passport.country
this.expirationDate = passport.expirationDate
this.fileId = passport.fileId
additionalProperties(passport.additionalProperties)
}
/** The country that issued the passport. */
@JsonProperty("country")
fun country(country: String) = apply { this.country = country }
/** The passport's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/** The identifier of the File containing the passport. */
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
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(): Passport =
Passport(
checkNotNull(country) { "`country` is required but was not set" },
checkNotNull(expirationDate) {
"`expirationDate` is required but was not set"
},
checkNotNull(fileId) { "`fileId` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
}
}
}
/**
* Details of the natural person entity to create. Required if `structure` is equal to
* `natural_person`. Natural people entities should be submitted with `social_security_number`
* or `individual_taxpayer_identification_number` identification methods.
*/
@JsonDeserialize(builder = NaturalPerson.Builder::class)
@NoAutoDetect
class NaturalPerson
private constructor(
private val address: Address?,
private val confirmedNoUsTaxId: Boolean?,
private val dateOfBirth: LocalDate?,
private val identification: Identification?,
private val name: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The individual's physical address. Mail receiving locations like PO Boxes and PMB's are
* disallowed.
*/
@JsonProperty("address") fun address(): Address? = address
/**
* The identification method for an individual can only be a passport, driver's license, or
* other document if you've confirmed the individual does not have a US tax id (either a
* Social Security Number or Individual Taxpayer Identification Number).
*/
@JsonProperty("confirmed_no_us_tax_id")
fun confirmedNoUsTaxId(): Boolean? = confirmedNoUsTaxId
/** The person's date of birth in YYYY-MM-DD format. */
@JsonProperty("date_of_birth") fun dateOfBirth(): LocalDate? = dateOfBirth
/** A means of verifying the person's identity. */
@JsonProperty("identification") fun identification(): Identification? = identification
/** The person's legal name. */
@JsonProperty("name") fun name(): String? = name
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is NaturalPerson &&
this.address == other.address &&
this.confirmedNoUsTaxId == other.confirmedNoUsTaxId &&
this.dateOfBirth == other.dateOfBirth &&
this.identification == other.identification &&
this.name == other.name &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
address,
confirmedNoUsTaxId,
dateOfBirth,
identification,
name,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"NaturalPerson{address=$address, confirmedNoUsTaxId=$confirmedNoUsTaxId, dateOfBirth=$dateOfBirth, identification=$identification, name=$name, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var address: Address? = null
private var confirmedNoUsTaxId: Boolean? = null
private var dateOfBirth: LocalDate? = null
private var identification: Identification? = null
private var name: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(naturalPerson: NaturalPerson) = apply {
this.address = naturalPerson.address
this.confirmedNoUsTaxId = naturalPerson.confirmedNoUsTaxId
this.dateOfBirth = naturalPerson.dateOfBirth
this.identification = naturalPerson.identification
this.name = naturalPerson.name
additionalProperties(naturalPerson.additionalProperties)
}
/**
* The individual's physical address. Mail receiving locations like PO Boxes and PMB's
* are disallowed.
*/
@JsonProperty("address")
fun address(address: Address) = apply { this.address = address }
/**
* The identification method for an individual can only be a passport, driver's license,
* or other document if you've confirmed the individual does not have a US tax id
* (either a Social Security Number or Individual Taxpayer Identification Number).
*/
@JsonProperty("confirmed_no_us_tax_id")
fun confirmedNoUsTaxId(confirmedNoUsTaxId: Boolean) = apply {
this.confirmedNoUsTaxId = confirmedNoUsTaxId
}
/** The person's date of birth in YYYY-MM-DD format. */
@JsonProperty("date_of_birth")
fun dateOfBirth(dateOfBirth: LocalDate) = apply { this.dateOfBirth = dateOfBirth }
/** A means of verifying the person's identity. */
@JsonProperty("identification")
fun identification(identification: Identification) = apply {
this.identification = identification
}
/** The person's legal name. */
@JsonProperty("name") fun name(name: String) = apply { this.name = name }
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(): NaturalPerson =
NaturalPerson(
checkNotNull(address) { "`address` is required but was not set" },
confirmedNoUsTaxId,
checkNotNull(dateOfBirth) { "`dateOfBirth` is required but was not set" },
checkNotNull(identification) { "`identification` is required but was not set" },
checkNotNull(name) { "`name` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
/**
* The individual's physical address. Mail receiving locations like PO Boxes and PMB's are
* disallowed.
*/
@JsonDeserialize(builder = Address.Builder::class)
@NoAutoDetect
class Address
private constructor(
private val city: String?,
private val line1: String?,
private val line2: String?,
private val state: String?,
private val zip: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The city of the address. */
@JsonProperty("city") fun city(): String? = city
/** The first line of the address. This is usually the street number and street. */
@JsonProperty("line1") fun line1(): String? = line1
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(): String? = line2
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state of the
* address.
*/
@JsonProperty("state") fun state(): String? = state
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(): String? = zip
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Address &&
this.city == other.city &&
this.line1 == other.line1 &&
this.line2 == other.line2 &&
this.state == other.state &&
this.zip == other.zip &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
city,
line1,
line2,
state,
zip,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Address{city=$city, line1=$line1, line2=$line2, state=$state, zip=$zip, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var city: String? = null
private var line1: String? = null
private var line2: String? = null
private var state: String? = null
private var zip: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(address: Address) = apply {
this.city = address.city
this.line1 = address.line1
this.line2 = address.line2
this.state = address.state
this.zip = address.zip
additionalProperties(address.additionalProperties)
}
/** The city of the address. */
@JsonProperty("city") fun city(city: String) = apply { this.city = city }
/** The first line of the address. This is usually the street number and street. */
@JsonProperty("line1") fun line1(line1: String) = apply { this.line1 = line1 }
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(line2: String) = apply { this.line2 = line2 }
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state of
* the address.
*/
@JsonProperty("state") fun state(state: String) = apply { this.state = state }
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(zip: String) = apply { this.zip = zip }
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(): Address =
Address(
checkNotNull(city) { "`city` is required but was not set" },
checkNotNull(line1) { "`line1` is required but was not set" },
line2,
checkNotNull(state) { "`state` is required but was not set" },
checkNotNull(zip) { "`zip` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/** A means of verifying the person's identity. */
@JsonDeserialize(builder = Identification.Builder::class)
@NoAutoDetect
class Identification
private constructor(
private val driversLicense: DriversLicense?,
private val method: Method?,
private val number: String?,
private val other: Other?,
private val passport: Passport?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* Information about the United States driver's license used for identification.
* Required if `method` is equal to `drivers_license`.
*/
@JsonProperty("drivers_license") fun driversLicense(): DriversLicense? = driversLicense
/** A method that can be used to verify the individual's identity. */
@JsonProperty("method") fun method(): Method? = method
/**
* An identification number that can be used to verify the individual's identity, such
* as a social security number.
*/
@JsonProperty("number") fun number(): String? = number
/**
* Information about the identification document provided. Required if `method` is equal
* to `other`.
*/
@JsonProperty("other") fun other(): Other? = other
/**
* Information about the passport used for identification. Required if `method` is equal
* to `passport`.
*/
@JsonProperty("passport") fun passport(): Passport? = passport
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Identification &&
this.driversLicense == other.driversLicense &&
this.method == other.method &&
this.number == other.number &&
this.other == other.other &&
this.passport == other.passport &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
driversLicense,
method,
number,
other,
passport,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Identification{driversLicense=$driversLicense, method=$method, number=$number, other=$other, passport=$passport, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var driversLicense: DriversLicense? = null
private var method: Method? = null
private var number: String? = null
private var other: Other? = null
private var passport: Passport? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(identification: Identification) = apply {
this.driversLicense = identification.driversLicense
this.method = identification.method
this.number = identification.number
this.other = identification.other
this.passport = identification.passport
additionalProperties(identification.additionalProperties)
}
/**
* Information about the United States driver's license used for identification.
* Required if `method` is equal to `drivers_license`.
*/
@JsonProperty("drivers_license")
fun driversLicense(driversLicense: DriversLicense) = apply {
this.driversLicense = driversLicense
}
/** A method that can be used to verify the individual's identity. */
@JsonProperty("method") fun method(method: Method) = apply { this.method = method }
/**
* An identification number that can be used to verify the individual's identity,
* such as a social security number.
*/
@JsonProperty("number") fun number(number: String) = apply { this.number = number }
/**
* Information about the identification document provided. Required if `method` is
* equal to `other`.
*/
@JsonProperty("other") fun other(other: Other) = apply { this.other = other }
/**
* Information about the passport used for identification. Required if `method` is
* equal to `passport`.
*/
@JsonProperty("passport")
fun passport(passport: Passport) = apply { this.passport = passport }
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(): Identification =
Identification(
driversLicense,
checkNotNull(method) { "`method` is required but was not set" },
checkNotNull(number) { "`number` is required but was not set" },
other,
passport,
additionalProperties.toUnmodifiable(),
)
}
class Method
@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 Method && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField
val SOCIAL_SECURITY_NUMBER = Method(JsonField.of("social_security_number"))
@JvmField
val INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
Method(JsonField.of("individual_taxpayer_identification_number"))
@JvmField val PASSPORT = Method(JsonField.of("passport"))
@JvmField val DRIVERS_LICENSE = Method(JsonField.of("drivers_license"))
@JvmField val OTHER = Method(JsonField.of("other"))
@JvmStatic fun of(value: String) = Method(JsonField.of(value))
}
enum class Known {
SOCIAL_SECURITY_NUMBER,
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER,
PASSPORT,
DRIVERS_LICENSE,
OTHER,
}
enum class Value {
SOCIAL_SECURITY_NUMBER,
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER,
PASSPORT,
DRIVERS_LICENSE,
OTHER,
_UNKNOWN,
}
fun value(): Value =
when (this) {
SOCIAL_SECURITY_NUMBER -> Value.SOCIAL_SECURITY_NUMBER
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER ->
Value.INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER
PASSPORT -> Value.PASSPORT
DRIVERS_LICENSE -> Value.DRIVERS_LICENSE
OTHER -> Value.OTHER
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
SOCIAL_SECURITY_NUMBER -> Known.SOCIAL_SECURITY_NUMBER
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER ->
Known.INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER
PASSPORT -> Known.PASSPORT
DRIVERS_LICENSE -> Known.DRIVERS_LICENSE
OTHER -> Known.OTHER
else -> throw IncreaseInvalidDataException("Unknown Method: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/**
* Information about the United States driver's license used for identification.
* Required if `method` is equal to `drivers_license`.
*/
@JsonDeserialize(builder = DriversLicense.Builder::class)
@NoAutoDetect
class DriversLicense
private constructor(
private val backFileId: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val state: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The identifier of the File containing the back of the driver's license. */
@JsonProperty("back_file_id") fun backFileId(): String? = backFileId
/** The driver's license's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date") fun expirationDate(): LocalDate? = expirationDate
/** The identifier of the File containing the front of the driver's license. */
@JsonProperty("file_id") fun fileId(): String? = fileId
/** The state that issued the provided driver's license. */
@JsonProperty("state") fun state(): String? = state
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is DriversLicense &&
this.backFileId == other.backFileId &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.state == other.state &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
backFileId,
expirationDate,
fileId,
state,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"DriversLicense{backFileId=$backFileId, expirationDate=$expirationDate, fileId=$fileId, state=$state, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var backFileId: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var state: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(driversLicense: DriversLicense) = apply {
this.backFileId = driversLicense.backFileId
this.expirationDate = driversLicense.expirationDate
this.fileId = driversLicense.fileId
this.state = driversLicense.state
additionalProperties(driversLicense.additionalProperties)
}
/** The identifier of the File containing the back of the driver's license. */
@JsonProperty("back_file_id")
fun backFileId(backFileId: String) = apply { this.backFileId = backFileId }
/** The driver's license's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/** The identifier of the File containing the front of the driver's license. */
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
/** The state that issued the provided driver's license. */
@JsonProperty("state") fun state(state: String) = apply { this.state = state }
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(): DriversLicense =
DriversLicense(
backFileId,
checkNotNull(expirationDate) {
"`expirationDate` is required but was not set"
},
checkNotNull(fileId) { "`fileId` is required but was not set" },
checkNotNull(state) { "`state` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/**
* Information about the identification document provided. Required if `method` is equal
* to `other`.
*/
@JsonDeserialize(builder = Other.Builder::class)
@NoAutoDetect
class Other
private constructor(
private val backFileId: String?,
private val country: String?,
private val description: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The identifier of the File containing the back of the document. Not every
* document has a reverse side.
*/
@JsonProperty("back_file_id") fun backFileId(): String? = backFileId
/**
* The two-character ISO 3166-1 code representing the country that issued the
* document.
*/
@JsonProperty("country") fun country(): String? = country
/** A description of the document submitted. */
@JsonProperty("description") fun description(): String? = description
/** The document's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date") fun expirationDate(): LocalDate? = expirationDate
/** The identifier of the File containing the front of the document. */
@JsonProperty("file_id") fun fileId(): String? = fileId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Other &&
this.backFileId == other.backFileId &&
this.country == other.country &&
this.description == other.description &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
backFileId,
country,
description,
expirationDate,
fileId,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Other{backFileId=$backFileId, country=$country, description=$description, expirationDate=$expirationDate, fileId=$fileId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var backFileId: String? = null
private var country: String? = null
private var description: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(other: Other) = apply {
this.backFileId = other.backFileId
this.country = other.country
this.description = other.description
this.expirationDate = other.expirationDate
this.fileId = other.fileId
additionalProperties(other.additionalProperties)
}
/**
* The identifier of the File containing the back of the document. Not every
* document has a reverse side.
*/
@JsonProperty("back_file_id")
fun backFileId(backFileId: String) = apply { this.backFileId = backFileId }
/**
* The two-character ISO 3166-1 code representing the country that issued the
* document.
*/
@JsonProperty("country")
fun country(country: String) = apply { this.country = country }
/** A description of the document submitted. */
@JsonProperty("description")
fun description(description: String) = apply { this.description = description }
/** The document's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/** The identifier of the File containing the front of the document. */
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
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(): Other =
Other(
backFileId,
checkNotNull(country) { "`country` is required but was not set" },
checkNotNull(description) {
"`description` is required but was not set"
},
expirationDate,
checkNotNull(fileId) { "`fileId` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/**
* Information about the passport used for identification. Required if `method` is equal
* to `passport`.
*/
@JsonDeserialize(builder = Passport.Builder::class)
@NoAutoDetect
class Passport
private constructor(
private val country: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The country that issued the passport. */
@JsonProperty("country") fun country(): String? = country
/** The passport's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date") fun expirationDate(): LocalDate? = expirationDate
/** The identifier of the File containing the passport. */
@JsonProperty("file_id") fun fileId(): String? = fileId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Passport &&
this.country == other.country &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
country,
expirationDate,
fileId,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Passport{country=$country, expirationDate=$expirationDate, fileId=$fileId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var country: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(passport: Passport) = apply {
this.country = passport.country
this.expirationDate = passport.expirationDate
this.fileId = passport.fileId
additionalProperties(passport.additionalProperties)
}
/** The country that issued the passport. */
@JsonProperty("country")
fun country(country: String) = apply { this.country = country }
/** The passport's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/** The identifier of the File containing the passport. */
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
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(): Passport =
Passport(
checkNotNull(country) { "`country` is required but was not set" },
checkNotNull(expirationDate) {
"`expirationDate` is required but was not set"
},
checkNotNull(fileId) { "`fileId` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
}
}
@JsonDeserialize(builder = SupplementalDocument.Builder::class)
@NoAutoDetect
class SupplementalDocument
private constructor(
private val fileId: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The identifier of the File containing the document. */
@JsonProperty("file_id") fun fileId(): String? = fileId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is SupplementalDocument &&
this.fileId == other.fileId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode = Objects.hash(fileId, additionalProperties)
}
return hashCode
}
override fun toString() =
"SupplementalDocument{fileId=$fileId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var fileId: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(supplementalDocument: SupplementalDocument) = apply {
this.fileId = supplementalDocument.fileId
additionalProperties(supplementalDocument.additionalProperties)
}
/** The identifier of the File containing the document. */
@JsonProperty("file_id") fun fileId(fileId: String) = apply { this.fileId = fileId }
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(): SupplementalDocument =
SupplementalDocument(
checkNotNull(fileId) { "`fileId` is required but was not set" },
additionalProperties.toUnmodifiable()
)
}
}
/** Details of the trust entity to create. Required if `structure` is equal to `trust`. */
@JsonDeserialize(builder = Trust.Builder::class)
@NoAutoDetect
class Trust
private constructor(
private val address: Address?,
private val category: Category?,
private val formationDocumentFileId: String?,
private val formationState: String?,
private val grantor: Grantor?,
private val name: String?,
private val taxIdentifier: String?,
private val trustees: List?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The trust's physical address. Mail receiving locations like PO Boxes and PMB's are
* disallowed.
*/
@JsonProperty("address") fun address(): Address? = address
/**
* Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require their own
* Employer Identification Number. Revocable trusts require information about the individual
* `grantor` who created the trust.
*/
@JsonProperty("category") fun category(): Category? = category
/** The identifier of the File containing the formation document of the trust. */
@JsonProperty("formation_document_file_id")
fun formationDocumentFileId(): String? = formationDocumentFileId
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state in which
* the trust was formed.
*/
@JsonProperty("formation_state") fun formationState(): String? = formationState
/** The grantor of the trust. Required if `category` is equal to `revocable`. */
@JsonProperty("grantor") fun grantor(): Grantor? = grantor
/** The legal name of the trust. */
@JsonProperty("name") fun name(): String? = name
/**
* The Employer Identification Number (EIN) for the trust. Required if `category` is equal
* to `irrevocable`.
*/
@JsonProperty("tax_identifier") fun taxIdentifier(): String? = taxIdentifier
/** The trustees of the trust. */
@JsonProperty("trustees") fun trustees(): List? = trustees
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Trust &&
this.address == other.address &&
this.category == other.category &&
this.formationDocumentFileId == other.formationDocumentFileId &&
this.formationState == other.formationState &&
this.grantor == other.grantor &&
this.name == other.name &&
this.taxIdentifier == other.taxIdentifier &&
this.trustees == other.trustees &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
address,
category,
formationDocumentFileId,
formationState,
grantor,
name,
taxIdentifier,
trustees,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Trust{address=$address, category=$category, formationDocumentFileId=$formationDocumentFileId, formationState=$formationState, grantor=$grantor, name=$name, taxIdentifier=$taxIdentifier, trustees=$trustees, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var address: Address? = null
private var category: Category? = null
private var formationDocumentFileId: String? = null
private var formationState: String? = null
private var grantor: Grantor? = null
private var name: String? = null
private var taxIdentifier: String? = null
private var trustees: List? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(trust: Trust) = apply {
this.address = trust.address
this.category = trust.category
this.formationDocumentFileId = trust.formationDocumentFileId
this.formationState = trust.formationState
this.grantor = trust.grantor
this.name = trust.name
this.taxIdentifier = trust.taxIdentifier
this.trustees = trust.trustees
additionalProperties(trust.additionalProperties)
}
/**
* The trust's physical address. Mail receiving locations like PO Boxes and PMB's are
* disallowed.
*/
@JsonProperty("address")
fun address(address: Address) = apply { this.address = address }
/**
* Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require their
* own Employer Identification Number. Revocable trusts require information about the
* individual `grantor` who created the trust.
*/
@JsonProperty("category")
fun category(category: Category) = apply { this.category = category }
/** The identifier of the File containing the formation document of the trust. */
@JsonProperty("formation_document_file_id")
fun formationDocumentFileId(formationDocumentFileId: String) = apply {
this.formationDocumentFileId = formationDocumentFileId
}
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state in
* which the trust was formed.
*/
@JsonProperty("formation_state")
fun formationState(formationState: String) = apply {
this.formationState = formationState
}
/** The grantor of the trust. Required if `category` is equal to `revocable`. */
@JsonProperty("grantor")
fun grantor(grantor: Grantor) = apply { this.grantor = grantor }
/** The legal name of the trust. */
@JsonProperty("name") fun name(name: String) = apply { this.name = name }
/**
* The Employer Identification Number (EIN) for the trust. Required if `category` is
* equal to `irrevocable`.
*/
@JsonProperty("tax_identifier")
fun taxIdentifier(taxIdentifier: String) = apply { this.taxIdentifier = taxIdentifier }
/** The trustees of the trust. */
@JsonProperty("trustees")
fun trustees(trustees: List) = apply { this.trustees = trustees }
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(): Trust =
Trust(
checkNotNull(address) { "`address` is required but was not set" },
checkNotNull(category) { "`category` is required but was not set" },
formationDocumentFileId,
formationState,
grantor,
checkNotNull(name) { "`name` is required but was not set" },
taxIdentifier,
checkNotNull(trustees) { "`trustees` is required but was not set" }
.toUnmodifiable(),
additionalProperties.toUnmodifiable(),
)
}
/**
* The trust's physical address. Mail receiving locations like PO Boxes and PMB's are
* disallowed.
*/
@JsonDeserialize(builder = Address.Builder::class)
@NoAutoDetect
class Address
private constructor(
private val city: String?,
private val line1: String?,
private val line2: String?,
private val state: String?,
private val zip: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The city of the address. */
@JsonProperty("city") fun city(): String? = city
/** The first line of the address. This is usually the street number and street. */
@JsonProperty("line1") fun line1(): String? = line1
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(): String? = line2
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state of the
* address.
*/
@JsonProperty("state") fun state(): String? = state
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(): String? = zip
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Address &&
this.city == other.city &&
this.line1 == other.line1 &&
this.line2 == other.line2 &&
this.state == other.state &&
this.zip == other.zip &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
city,
line1,
line2,
state,
zip,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Address{city=$city, line1=$line1, line2=$line2, state=$state, zip=$zip, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var city: String? = null
private var line1: String? = null
private var line2: String? = null
private var state: String? = null
private var zip: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(address: Address) = apply {
this.city = address.city
this.line1 = address.line1
this.line2 = address.line2
this.state = address.state
this.zip = address.zip
additionalProperties(address.additionalProperties)
}
/** The city of the address. */
@JsonProperty("city") fun city(city: String) = apply { this.city = city }
/** The first line of the address. This is usually the street number and street. */
@JsonProperty("line1") fun line1(line1: String) = apply { this.line1 = line1 }
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(line2: String) = apply { this.line2 = line2 }
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state of
* the address.
*/
@JsonProperty("state") fun state(state: String) = apply { this.state = state }
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(zip: String) = apply { this.zip = zip }
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(): Address =
Address(
checkNotNull(city) { "`city` is required but was not set" },
checkNotNull(line1) { "`line1` is required but was not set" },
line2,
checkNotNull(state) { "`state` is required but was not set" },
checkNotNull(zip) { "`zip` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
class Category
@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 Category && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val REVOCABLE = Category(JsonField.of("revocable"))
@JvmField val IRREVOCABLE = Category(JsonField.of("irrevocable"))
@JvmStatic fun of(value: String) = Category(JsonField.of(value))
}
enum class Known {
REVOCABLE,
IRREVOCABLE,
}
enum class Value {
REVOCABLE,
IRREVOCABLE,
_UNKNOWN,
}
fun value(): Value =
when (this) {
REVOCABLE -> Value.REVOCABLE
IRREVOCABLE -> Value.IRREVOCABLE
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
REVOCABLE -> Known.REVOCABLE
IRREVOCABLE -> Known.IRREVOCABLE
else -> throw IncreaseInvalidDataException("Unknown Category: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
@JsonDeserialize(builder = Trustee.Builder::class)
@NoAutoDetect
class Trustee
private constructor(
private val individual: Individual?,
private val structure: Structure?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* Details of the individual trustee. Required when the trustee `structure` is equal to
* `individual`.
*/
@JsonProperty("individual") fun individual(): Individual? = individual
/** The structure of the trustee. */
@JsonProperty("structure") fun structure(): Structure? = structure
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Trustee &&
this.individual == other.individual &&
this.structure == other.structure &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
individual,
structure,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Trustee{individual=$individual, structure=$structure, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var individual: Individual? = null
private var structure: Structure? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(trustee: Trustee) = apply {
this.individual = trustee.individual
this.structure = trustee.structure
additionalProperties(trustee.additionalProperties)
}
/**
* Details of the individual trustee. Required when the trustee `structure` is equal
* to `individual`.
*/
@JsonProperty("individual")
fun individual(individual: Individual) = apply { this.individual = individual }
/** The structure of the trustee. */
@JsonProperty("structure")
fun structure(structure: Structure) = apply { this.structure = structure }
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(): Trustee =
Trustee(
individual,
checkNotNull(structure) { "`structure` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
class Structure
@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 Structure && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField val INDIVIDUAL = Structure(JsonField.of("individual"))
@JvmStatic fun of(value: String) = Structure(JsonField.of(value))
}
enum class Known {
INDIVIDUAL,
}
enum class Value {
INDIVIDUAL,
_UNKNOWN,
}
fun value(): Value =
when (this) {
INDIVIDUAL -> Value.INDIVIDUAL
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
INDIVIDUAL -> Known.INDIVIDUAL
else -> throw IncreaseInvalidDataException("Unknown Structure: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/**
* Details of the individual trustee. Required when the trustee `structure` is equal to
* `individual`.
*/
@JsonDeserialize(builder = Individual.Builder::class)
@NoAutoDetect
class Individual
private constructor(
private val address: Address?,
private val confirmedNoUsTaxId: Boolean?,
private val dateOfBirth: LocalDate?,
private val identification: Identification?,
private val name: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The individual's physical address. Mail receiving locations like PO Boxes and
* PMB's are disallowed.
*/
@JsonProperty("address") fun address(): Address? = address
/**
* The identification method for an individual can only be a passport, driver's
* license, or other document if you've confirmed the individual does not have a US
* tax id (either a Social Security Number or Individual Taxpayer Identification
* Number).
*/
@JsonProperty("confirmed_no_us_tax_id")
fun confirmedNoUsTaxId(): Boolean? = confirmedNoUsTaxId
/** The person's date of birth in YYYY-MM-DD format. */
@JsonProperty("date_of_birth") fun dateOfBirth(): LocalDate? = dateOfBirth
/** A means of verifying the person's identity. */
@JsonProperty("identification")
fun identification(): Identification? = identification
/** The person's legal name. */
@JsonProperty("name") fun name(): String? = name
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Individual &&
this.address == other.address &&
this.confirmedNoUsTaxId == other.confirmedNoUsTaxId &&
this.dateOfBirth == other.dateOfBirth &&
this.identification == other.identification &&
this.name == other.name &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
address,
confirmedNoUsTaxId,
dateOfBirth,
identification,
name,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Individual{address=$address, confirmedNoUsTaxId=$confirmedNoUsTaxId, dateOfBirth=$dateOfBirth, identification=$identification, name=$name, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var address: Address? = null
private var confirmedNoUsTaxId: Boolean? = null
private var dateOfBirth: LocalDate? = null
private var identification: Identification? = null
private var name: String? = null
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(individual: Individual) = apply {
this.address = individual.address
this.confirmedNoUsTaxId = individual.confirmedNoUsTaxId
this.dateOfBirth = individual.dateOfBirth
this.identification = individual.identification
this.name = individual.name
additionalProperties(individual.additionalProperties)
}
/**
* The individual's physical address. Mail receiving locations like PO Boxes and
* PMB's are disallowed.
*/
@JsonProperty("address")
fun address(address: Address) = apply { this.address = address }
/**
* The identification method for an individual can only be a passport, driver's
* license, or other document if you've confirmed the individual does not have a
* US tax id (either a Social Security Number or Individual Taxpayer
* Identification Number).
*/
@JsonProperty("confirmed_no_us_tax_id")
fun confirmedNoUsTaxId(confirmedNoUsTaxId: Boolean) = apply {
this.confirmedNoUsTaxId = confirmedNoUsTaxId
}
/** The person's date of birth in YYYY-MM-DD format. */
@JsonProperty("date_of_birth")
fun dateOfBirth(dateOfBirth: LocalDate) = apply {
this.dateOfBirth = dateOfBirth
}
/** A means of verifying the person's identity. */
@JsonProperty("identification")
fun identification(identification: Identification) = apply {
this.identification = identification
}
/** The person's legal name. */
@JsonProperty("name") fun name(name: String) = apply { this.name = name }
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(): Individual =
Individual(
checkNotNull(address) { "`address` is required but was not set" },
confirmedNoUsTaxId,
checkNotNull(dateOfBirth) {
"`dateOfBirth` is required but was not set"
},
checkNotNull(identification) {
"`identification` is required but was not set"
},
checkNotNull(name) { "`name` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
/**
* The individual's physical address. Mail receiving locations like PO Boxes and
* PMB's are disallowed.
*/
@JsonDeserialize(builder = Address.Builder::class)
@NoAutoDetect
class Address
private constructor(
private val city: String?,
private val line1: String?,
private val line2: String?,
private val state: String?,
private val zip: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The city of the address. */
@JsonProperty("city") fun city(): String? = city
/**
* The first line of the address. This is usually the street number and street.
*/
@JsonProperty("line1") fun line1(): String? = line1
/** The second line of the address. This might be the floor or room number. */
@JsonProperty("line2") fun line2(): String? = line2
/**
* The two-letter United States Postal Service (USPS) abbreviation for the state
* of the address.
*/
@JsonProperty("state") fun state(): String? = state
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(): String? = zip
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Address &&
this.city == other.city &&
this.line1 == other.line1 &&
this.line2 == other.line2 &&
this.state == other.state &&
this.zip == other.zip &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
city,
line1,
line2,
state,
zip,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Address{city=$city, line1=$line1, line2=$line2, state=$state, zip=$zip, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var city: String? = null
private var line1: String? = null
private var line2: String? = null
private var state: String? = null
private var zip: String? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(address: Address) = apply {
this.city = address.city
this.line1 = address.line1
this.line2 = address.line2
this.state = address.state
this.zip = address.zip
additionalProperties(address.additionalProperties)
}
/** The city of the address. */
@JsonProperty("city") fun city(city: String) = apply { this.city = city }
/**
* The first line of the address. This is usually the street number and
* street.
*/
@JsonProperty("line1")
fun line1(line1: String) = apply { this.line1 = line1 }
/**
* The second line of the address. This might be the floor or room number.
*/
@JsonProperty("line2")
fun line2(line2: String) = apply { this.line2 = line2 }
/**
* The two-letter United States Postal Service (USPS) abbreviation for the
* state of the address.
*/
@JsonProperty("state")
fun state(state: String) = apply { this.state = state }
/** The ZIP code of the address. */
@JsonProperty("zip") fun zip(zip: String) = apply { this.zip = zip }
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(): Address =
Address(
checkNotNull(city) { "`city` is required but was not set" },
checkNotNull(line1) { "`line1` is required but was not set" },
line2,
checkNotNull(state) { "`state` is required but was not set" },
checkNotNull(zip) { "`zip` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/** A means of verifying the person's identity. */
@JsonDeserialize(builder = Identification.Builder::class)
@NoAutoDetect
class Identification
private constructor(
private val driversLicense: DriversLicense?,
private val method: Method?,
private val number: String?,
private val other: Other?,
private val passport: Passport?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* Information about the United States driver's license used for identification.
* Required if `method` is equal to `drivers_license`.
*/
@JsonProperty("drivers_license")
fun driversLicense(): DriversLicense? = driversLicense
/** A method that can be used to verify the individual's identity. */
@JsonProperty("method") fun method(): Method? = method
/**
* An identification number that can be used to verify the individual's
* identity, such as a social security number.
*/
@JsonProperty("number") fun number(): String? = number
/**
* Information about the identification document provided. Required if `method`
* is equal to `other`.
*/
@JsonProperty("other") fun other(): Other? = other
/**
* Information about the passport used for identification. Required if `method`
* is equal to `passport`.
*/
@JsonProperty("passport") fun passport(): Passport? = passport
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Identification &&
this.driversLicense == other.driversLicense &&
this.method == other.method &&
this.number == other.number &&
this.other == other.other &&
this.passport == other.passport &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
driversLicense,
method,
number,
other,
passport,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Identification{driversLicense=$driversLicense, method=$method, number=$number, other=$other, passport=$passport, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var driversLicense: DriversLicense? = null
private var method: Method? = null
private var number: String? = null
private var other: Other? = null
private var passport: Passport? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(identification: Identification) = apply {
this.driversLicense = identification.driversLicense
this.method = identification.method
this.number = identification.number
this.other = identification.other
this.passport = identification.passport
additionalProperties(identification.additionalProperties)
}
/**
* Information about the United States driver's license used for
* identification. Required if `method` is equal to `drivers_license`.
*/
@JsonProperty("drivers_license")
fun driversLicense(driversLicense: DriversLicense) = apply {
this.driversLicense = driversLicense
}
/** A method that can be used to verify the individual's identity. */
@JsonProperty("method")
fun method(method: Method) = apply { this.method = method }
/**
* An identification number that can be used to verify the individual's
* identity, such as a social security number.
*/
@JsonProperty("number")
fun number(number: String) = apply { this.number = number }
/**
* Information about the identification document provided. Required if
* `method` is equal to `other`.
*/
@JsonProperty("other")
fun other(other: Other) = apply { this.other = other }
/**
* Information about the passport used for identification. Required if
* `method` is equal to `passport`.
*/
@JsonProperty("passport")
fun passport(passport: Passport) = apply { this.passport = passport }
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(): Identification =
Identification(
driversLicense,
checkNotNull(method) { "`method` is required but was not set" },
checkNotNull(number) { "`number` is required but was not set" },
other,
passport,
additionalProperties.toUnmodifiable(),
)
}
class Method
@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 Method && this.value == other.value
}
override fun hashCode() = value.hashCode()
override fun toString() = value.toString()
companion object {
@JvmField
val SOCIAL_SECURITY_NUMBER =
Method(JsonField.of("social_security_number"))
@JvmField
val INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER =
Method(JsonField.of("individual_taxpayer_identification_number"))
@JvmField val PASSPORT = Method(JsonField.of("passport"))
@JvmField val DRIVERS_LICENSE = Method(JsonField.of("drivers_license"))
@JvmField val OTHER = Method(JsonField.of("other"))
@JvmStatic fun of(value: String) = Method(JsonField.of(value))
}
enum class Known {
SOCIAL_SECURITY_NUMBER,
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER,
PASSPORT,
DRIVERS_LICENSE,
OTHER,
}
enum class Value {
SOCIAL_SECURITY_NUMBER,
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER,
PASSPORT,
DRIVERS_LICENSE,
OTHER,
_UNKNOWN,
}
fun value(): Value =
when (this) {
SOCIAL_SECURITY_NUMBER -> Value.SOCIAL_SECURITY_NUMBER
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER ->
Value.INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER
PASSPORT -> Value.PASSPORT
DRIVERS_LICENSE -> Value.DRIVERS_LICENSE
OTHER -> Value.OTHER
else -> Value._UNKNOWN
}
fun known(): Known =
when (this) {
SOCIAL_SECURITY_NUMBER -> Known.SOCIAL_SECURITY_NUMBER
INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER ->
Known.INDIVIDUAL_TAXPAYER_IDENTIFICATION_NUMBER
PASSPORT -> Known.PASSPORT
DRIVERS_LICENSE -> Known.DRIVERS_LICENSE
OTHER -> Known.OTHER
else -> throw IncreaseInvalidDataException("Unknown Method: $value")
}
fun asString(): String = _value().asStringOrThrow()
}
/**
* Information about the United States driver's license used for identification.
* Required if `method` is equal to `drivers_license`.
*/
@JsonDeserialize(builder = DriversLicense.Builder::class)
@NoAutoDetect
class DriversLicense
private constructor(
private val backFileId: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val state: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The identifier of the File containing the back of the driver's license.
*/
@JsonProperty("back_file_id") fun backFileId(): String? = backFileId
/** The driver's license's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(): LocalDate? = expirationDate
/**
* The identifier of the File containing the front of the driver's license.
*/
@JsonProperty("file_id") fun fileId(): String? = fileId
/** The state that issued the provided driver's license. */
@JsonProperty("state") fun state(): String? = state
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is DriversLicense &&
this.backFileId == other.backFileId &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.state == other.state &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
backFileId,
expirationDate,
fileId,
state,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"DriversLicense{backFileId=$backFileId, expirationDate=$expirationDate, fileId=$fileId, state=$state, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var backFileId: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var state: String? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(driversLicense: DriversLicense) = apply {
this.backFileId = driversLicense.backFileId
this.expirationDate = driversLicense.expirationDate
this.fileId = driversLicense.fileId
this.state = driversLicense.state
additionalProperties(driversLicense.additionalProperties)
}
/**
* The identifier of the File containing the back of the driver's
* license.
*/
@JsonProperty("back_file_id")
fun backFileId(backFileId: String) = apply {
this.backFileId = backFileId
}
/** The driver's license's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/**
* The identifier of the File containing the front of the driver's
* license.
*/
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
/** The state that issued the provided driver's license. */
@JsonProperty("state")
fun state(state: String) = apply { this.state = state }
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(): DriversLicense =
DriversLicense(
backFileId,
checkNotNull(expirationDate) {
"`expirationDate` is required but was not set"
},
checkNotNull(fileId) { "`fileId` is required but was not set" },
checkNotNull(state) { "`state` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/**
* Information about the identification document provided. Required if `method`
* is equal to `other`.
*/
@JsonDeserialize(builder = Other.Builder::class)
@NoAutoDetect
class Other
private constructor(
private val backFileId: String?,
private val country: String?,
private val description: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/**
* The identifier of the File containing the back of the document. Not every
* document has a reverse side.
*/
@JsonProperty("back_file_id") fun backFileId(): String? = backFileId
/**
* The two-character ISO 3166-1 code representing the country that issued
* the document.
*/
@JsonProperty("country") fun country(): String? = country
/** A description of the document submitted. */
@JsonProperty("description") fun description(): String? = description
/** The document's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(): LocalDate? = expirationDate
/** The identifier of the File containing the front of the document. */
@JsonProperty("file_id") fun fileId(): String? = fileId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Other &&
this.backFileId == other.backFileId &&
this.country == other.country &&
this.description == other.description &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
backFileId,
country,
description,
expirationDate,
fileId,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Other{backFileId=$backFileId, country=$country, description=$description, expirationDate=$expirationDate, fileId=$fileId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var backFileId: String? = null
private var country: String? = null
private var description: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(other: Other) = apply {
this.backFileId = other.backFileId
this.country = other.country
this.description = other.description
this.expirationDate = other.expirationDate
this.fileId = other.fileId
additionalProperties(other.additionalProperties)
}
/**
* The identifier of the File containing the back of the document. Not
* every document has a reverse side.
*/
@JsonProperty("back_file_id")
fun backFileId(backFileId: String) = apply {
this.backFileId = backFileId
}
/**
* The two-character ISO 3166-1 code representing the country that
* issued the document.
*/
@JsonProperty("country")
fun country(country: String) = apply { this.country = country }
/** A description of the document submitted. */
@JsonProperty("description")
fun description(description: String) = apply {
this.description = description
}
/** The document's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/** The identifier of the File containing the front of the document. */
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
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(): Other =
Other(
backFileId,
checkNotNull(country) {
"`country` is required but was not set"
},
checkNotNull(description) {
"`description` is required but was not set"
},
expirationDate,
checkNotNull(fileId) { "`fileId` is required but was not set" },
additionalProperties.toUnmodifiable(),
)
}
}
/**
* Information about the passport used for identification. Required if `method`
* is equal to `passport`.
*/
@JsonDeserialize(builder = Passport.Builder::class)
@NoAutoDetect
class Passport
private constructor(
private val country: String?,
private val expirationDate: LocalDate?,
private val fileId: String?,
private val additionalProperties: Map,
) {
private var hashCode: Int = 0
/** The country that issued the passport. */
@JsonProperty("country") fun country(): String? = country
/** The passport's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(): LocalDate? = expirationDate
/** The identifier of the File containing the passport. */
@JsonProperty("file_id") fun fileId(): String? = fileId
@JsonAnyGetter
@ExcludeMissing
fun _additionalProperties(): Map = additionalProperties
fun toBuilder() = Builder().from(this)
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
return other is Passport &&
this.country == other.country &&
this.expirationDate == other.expirationDate &&
this.fileId == other.fileId &&
this.additionalProperties == other.additionalProperties
}
override fun hashCode(): Int {
if (hashCode == 0) {
hashCode =
Objects.hash(
country,
expirationDate,
fileId,
additionalProperties,
)
}
return hashCode
}
override fun toString() =
"Passport{country=$country, expirationDate=$expirationDate, fileId=$fileId, additionalProperties=$additionalProperties}"
companion object {
@JvmStatic fun builder() = Builder()
}
class Builder {
private var country: String? = null
private var expirationDate: LocalDate? = null
private var fileId: String? = null
private var additionalProperties: MutableMap =
mutableMapOf()
@JvmSynthetic
internal fun from(passport: Passport) = apply {
this.country = passport.country
this.expirationDate = passport.expirationDate
this.fileId = passport.fileId
additionalProperties(passport.additionalProperties)
}
/** The country that issued the passport. */
@JsonProperty("country")
fun country(country: String) = apply { this.country = country }
/** The passport's expiration date in YYYY-MM-DD format. */
@JsonProperty("expiration_date")
fun expirationDate(expirationDate: LocalDate) = apply {
this.expirationDate = expirationDate
}
/** The identifier of the File containing the passport. */
@JsonProperty("file_id")
fun fileId(fileId: String) = apply { this.fileId = fileId }
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