SeamSchema

object SeamSchema

Schema definitions for returned data.

Types

Link copied to clipboard
Link copied to clipboard
@Serializable
data class AcsCredential(val externalType: SeamSchema.ExternalType, val cardNumber: String?, val accessMethod: SeamSchema.AcsAccessMethod? = null) : SeamSchema.IAcsCredential
Link copied to clipboard
@Serializable
data class AcsSystem(val acsSystemId: String, val externalType: SeamSchema.ExternalType)
Link copied to clipboard
@Serializable
data class AssaAbloyApplicationConfiguration(val applicationId: String, val applicationDescription: String? = null)

ASSA ABLOY app configuration.

Link copied to clipboard
@Serializable
data class AssaAbloyCard(val cancelled: Boolean, val endpointId: String, val format: SeamSchema.AssaAbloyCard.Format, val id: String, val serialNumbers: List<String>, val uniqueRegistrationNumber: Int, val credentialID: Int)

ASSA ABLOY key card.

Link copied to clipboard
@Serializable
data class AssaAbloyEndpoint(val endpointId: String, val inviteCode: String, val status: SeamSchema.AssaAbloyEndpoint.Status, val details: SeamSchema.AssaAbloyEndpointDetails? = null)

ASSA ABLOY endpoint.

Link copied to clipboard
@Serializable
data class AssaAbloyEndpointDetails(val deviceManufacturer: String, val deviceModel: String, val osVersion: String, val applicationVersion: String, val seosAppletVersion: String, val bleCapability: Boolean, val hceCapability: Boolean, val nfcCapability: Boolean, val seosTsmEndpointId: Int)

ASSA ABLOY endpoint details.

Link copied to clipboard
@Serializable
data class ClientSession(val clientSessionId: String, val token: String)
Link copied to clipboard
@Serializable
sealed class Endpoint

Endpoint type.

Link copied to clipboard
@SerialName(value = "assa_abloy_credential_service")
@Serializable
data class EndpointAssaAbloy(val endpointId: String, val isActive: Boolean, val seosTsmEndpointId: Int? = null) : SeamSchema.Endpoint

ASSA ABLOY credential service endpoint.

Link copied to clipboard
@SerialName(value = "hid_credential_manager")
@Serializable
data class EndpointHID(val endpointId: String) : SeamSchema.Endpoint

HID credential manager.

Link copied to clipboard

Brand-specific terminology for the ACS system.

Link copied to clipboard
@Serializable
data class FakeCredential(val format: SeamSchema.FakeCredential.CredentialFormat, val cardNumber: String, val facilityCode: String)

Fake credential.

Link copied to clipboard
@Serializable
enum HIDBoolean : Enum<SeamSchema.HIDBoolean>

HID Boolean representation.

Link copied to clipboard
@Serializable
data class HIDCredentialContainer(val osVersion: String, val secureElementType: SeamSchema.HIDSecureElementType, val manufacturer: String, val model: String, val applicationVersion: String, val bluetoothCapability: SeamSchema.HIDBoolean, val nfcCapability: SeamSchema.HIDBoolean, val hceCapability: SeamSchema.HIDBoolean, val credentialContainerId: Int)

HID credential container.

Link copied to clipboard
@Serializable
data class HIDCredentialContainerInitializer(val osVersion: String, val secureElementType: SeamSchema.HIDSecureElementType, val manufacturer: String, val model: String, val applicationVersion: String, val bluetoothCapability: SeamSchema.HIDBoolean, val nfcCapability: SeamSchema.HIDBoolean, val hceCapability: SeamSchema.HIDBoolean)

HID credential container initializer.

Link copied to clipboard
@Serializable
data class HIDFakeCredential(val credentialNumber: Int, val mobileID: SeamSchema.HIDFakeMobileID)

Fake HID credential.

Link copied to clipboard
@Serializable
data class HIDFakeMobileID(val partNumber: String, val programmingData: SeamSchema.HIDFakeMobileID.ProgrammingData)

Fake HID mobile ID.

Link copied to clipboard

HID secure element type (EMULATED or NATIVE).

Link copied to clipboard
interface IAcsCredential
Link copied to clipboard
@Serializable
data class Phone(val phoneId: String, val nativeMetadata: SeamSchema.PhoneNativeMetadata)

App user's phone.

Link copied to clipboard
@Serializable
data class PhoneNativeMetadata(val isInitialized: Boolean, val isUnlockWithTapEnabled: Boolean, val canUnlockWithTap: Boolean?, val errors: List<SeamError>, val warnings: List<SeamWarning>, val isBluetoothEnabled: Boolean, val isInternetConnected: Boolean, val assaAbloyCredentialServiceMetadata: SeamSchema.SeosSdkMetadata?, val hidOrigoCredentialServiceMetadata: SeamSchema.SeosSdkMetadata?)

App user's phone metadata.

Link copied to clipboard
@Serializable
data class SaltoKSMobileKey(val mKey: String, val mobileKeyExpiryDate: String, val saltoKSSdkApiKey: String, val saltoKSSdkInstallationId: String)
Link copied to clipboard
@Serializable
data class SaltoSpaceRegistration(val binaryData: String, val installationId: String)
Link copied to clipboard
@Serializable
data class SeosEndpointInfo(val seosId: String, val server: String, val mobileKeysAPIVersion: String, val appVersion: String, val lastServerSyncDate: String?, val isPersonalized: Boolean)

SEOS endpoint information.

Link copied to clipboard
@Serializable
data class SeosSdkMetadata(val lastTsmCommunicationTimestamp: String?, val sdkVersion: String, val lastErrorCode: SeamError?, val lastReaderCommunication: String?, val endpointInfo: SeamSchema.SeosEndpointInfo?, val externalKeyIds: List<String>)

SEOS SDK metadata.

Link copied to clipboard
@Serializable
data class SimulatorFakeReader(val id: Int, val name: String, val rssi: Int)

Reader simulator.

Link copied to clipboard
@Serializable
data class UnlockWithTap(val isScanning: Boolean, val canScan: Boolean, val errors: List<SeamError>, val warnings: List<SeamWarning>)

PhoneNative.UnlockWithTap status.

Link copied to clipboard
@Serializable
data class Workspace(val workspaceId: String, val name: String, val isSandbox: Boolean)

Seam workspace.