prismsdk/tech.prismlabs.prismsdk.api_client/NewUser

NewUser

data class NewUser(val token: String, val email: String?, val sex: UserSex, val region: UserRegion = UserRegion.NORTH_AMERICA, val usaResidence: String?, val birthDate: LocalDate, val weight: Weight, val height: Height, val researchConsent: Boolean, val termsOfService: TermsOfService)

A object representing the data used to create a new user in Prism's systems. This must be done before any scans can be created. Note that user creation will fail if the user does not explicitly accept the terms of service.

Constructors

Link copied to clipboard
constructor(token: String, email: String?, sex: UserSex, region: UserRegion = UserRegion.NORTH_AMERICA, usaResidence: String?, birthDate: LocalDate, weight: Weight, height: Height, researchConsent: Boolean, termsOfService: TermsOfService)

Properties

Link copied to clipboard
val birthDate: LocalDate

{LocalDate} The birthdate of the user

Link copied to clipboard
val email: String?

{string} The email of the user

Link copied to clipboard
val height: Height

{Height} The height of the user

Link copied to clipboard
val region: UserRegion

{string} The region the user resides in

Link copied to clipboard
val researchConsent: Boolean

{boolean} Research Consent for the user. This is used to enroll or unenroll the user in using the uploaded body scans for training purposes.

Link copied to clipboard
val sex: UserSex

{UserSex} The sex of the user

Link copied to clipboard
val termsOfService: TermsOfService

{TermsOfService} A property that is explicit acceptance by the user of the TOS

Link copied to clipboard
val token: String

{string} The 3rd-party identifier of the user associated with the scan

Link copied to clipboard
val usaResidence: String?

{string} The US state the user resides in

Link copied to clipboard
val weight: Weight

{Weight} The weight of the user