TimeBoundAccessCode.md

seamapi / Exports / TimeBoundAccessCode

Interface: TimeBoundAccessCode

Hierarchy

• ManagedAccessCodeBase

  ↳ TimeBoundAccessCode

Table of contents

Properties

• access_code_id
• appearance
• code
• common_code_key
• created_at
• device_id
• ends_at
• errors
• is_backup
• is_backup_access_code_available
• is_external_modification_allowed
• is_scheduled_on_device
• is_waiting_for_code_assignment
• name
• pulled_backup_access_code_id
• starts_at
• status
• type
• warnings

Properties

access_code_id

• access_code_id: string

Inherited from

ManagedAccessCodeBase.access_code_id

Defined in

src/types/models.ts:417

---

appearance

• appearance: Object

Index signature

▪ [key: string]: any

Type declaration

Name	Type
name?	string

Inherited from

ManagedAccessCodeBase.appearance

Defined in

src/types/models.ts:426

---

code

• code: null | string

Inherited from

ManagedAccessCodeBase.code

Defined in

src/types/models.ts:420

---

common_code_key

• Optional common_code_key: null | string

Inherited from

ManagedAccessCodeBase.common_code_key

Defined in

src/types/models.ts:434

---

created_at

• created_at: string

Defined in

src/types/models.ts:446

---

device_id

• device_id: string

Inherited from

ManagedAccessCodeBase.device_id

Defined in

src/types/models.ts:418

---

ends_at

• ends_at: string

Defined in

src/types/models.ts:450

---

errors

• errors: (DeviceError | ConnectedAccountError | AccessCodeError)[]

Inherited from

ManagedAccessCodeBase.errors

Defined in

src/types/models.ts:424

---

is_backup

• Optional is_backup: boolean

Inherited from

ManagedAccessCodeBase.is_backup

Defined in

src/types/models.ts:421

---

is_backup_access_code_available

• is_backup_access_code_available: boolean

Inherited from

ManagedAccessCodeBase.is_backup_access_code_available

Defined in

src/types/models.ts:423

---

is_external_modification_allowed

• is_external_modification_allowed: boolean

Inherited from

ManagedAccessCodeBase.is_external_modification_allowed

Defined in

src/types/models.ts:433

---

is_scheduled_on_device

• Optional is_scheduled_on_device: boolean

Defined in

src/types/models.ts:448

---

is_waiting_for_code_assignment

• Optional is_waiting_for_code_assignment: true

Inherited from

ManagedAccessCodeBase.is_waiting_for_code_assignment

Defined in

src/types/models.ts:435

---

name

• Optional name: string

Inherited from

ManagedAccessCodeBase.name

Defined in

src/types/models.ts:419

---

pulled_backup_access_code_id

• Optional pulled_backup_access_code_id: null | string

Inherited from

ManagedAccessCodeBase.pulled_backup_access_code_id

Defined in

src/types/models.ts:422

---

starts_at

• starts_at: string

Defined in

src/types/models.ts:449

---

status

• status: "setting" | "set" | "unset" | "removing"

Defined in

src/types/models.ts:447

---

type

• type: "time_bound"

Defined in

src/types/models.ts:445

---

warnings

• warnings: SeamWarning[]

Inherited from

ManagedAccessCodeBase.warnings

Defined in

src/types/models.ts:425