Class: Seam::Resources::UnmanagedAccessCode

Inherits:
BaseResource show all
Defined in:
lib/seam/resources/unmanaged_access_code.rb

Overview

Represents an unmanaged smart lock access code.

An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.

When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.

Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.

Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:

Defined Under Namespace

Classes: DormakabaOracodeMetadata, Errors, Warnings

Instance Attribute Summary collapse

Attributes inherited from BaseResource

#client, #data

Instance Method Summary collapse

Methods inherited from BaseResource

#[], date_accessor, #initialize, #inspect, load_from_response, resource_accessor, resource_accessors, resource_list_accessor, resource_list_accessors, #update_from_response

Constructor Details

This class inherits a constructor from Seam::Resources::BaseResource

Instance Attribute Details

#access_code_id ⇒ String

Unique identifier for the access code.

Returns:

  • (String) 


131
132
133
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 131

def access_code_id
  @access_code_id
end

#cannot_be_managed ⇒ Boolean?

Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations.

Returns:

  • (Boolean, nil) 


134
135
136
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 134

def cannot_be_managed
  @cannot_be_managed
end

#cannot_delete_unmanaged_access_code ⇒ Boolean?

Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app.

Returns:

  • (Boolean, nil) 


137
138
139
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 137

def cannot_delete_unmanaged_access_code
  @cannot_delete_unmanaged_access_code
end

#code ⇒ String?

Code used for access. Typically, a numeric or alphanumeric string.

Returns:

  • (String, nil) 


140
141
142
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 140

def code
  @code
end

#device_id ⇒ String

Unique identifier for the device associated with the access code.

Returns:

  • (String) 


143
144
145
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 143

def device_id
  @device_id
end

#is_managed ⇒ Boolean

Indicates that Seam does not manage the access code.

Returns:

  • (Boolean) 


146
147
148
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 146

def is_managed
  @is_managed
end

#name ⇒ String?

Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as first_name and last_name. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called appearance. This is an object with a name property and, optionally, first_name and last_name properties (for providers that break down a name into components).

Returns:

  • (String, nil) 


149
150
151
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 149

def name
  @name
end

#status ⇒ String

Current status of the access code within the operational lifecycle. set indicates that the code is active and operational. unset indicates that the code exists on the provider but is not usable on the device.

Returns:

  • (String) 


152
153
154
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 152

def status
  @status
end

#type ⇒ String

Type of the access code. ongoing access codes are active continuously until deactivated manually. time_bound access codes have a specific duration.

Returns:

  • (String) 


155
156
157
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 155

def type
  @type
end

#workspace_id ⇒ String

Unique identifier for the Seam workspace associated with the access code.

Returns:

  • (String) 


158
159
160
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 158

def workspace_id
  @workspace_id
end

Instance Method Details

#created_at ⇒ Time

Date and time at which the access code was created.

Returns:

  • (Time) 


162
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 162

date_accessor :created_at

#dormakaba_oracode_metadata ⇒ DormakabaOracodeMetadata?

Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices.

Returns:



122
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 122

resource_accessor :dormakaba_oracode_metadata, DormakabaOracodeMetadata

#ends_at ⇒ Time?

Date and time after which the time-bound access code becomes inactive.

Returns:

  • (Time, nil) 


166
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 166

date_accessor :ends_at

#errors ⇒ Array<Errors>

Errors associated with the access code.

Returns:



125
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 125

resource_list_accessor :errors, Errors

#starts_at ⇒ Time?

Date and time at which the time-bound access code becomes active.

Returns:

  • (Time, nil) 


170
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 170

date_accessor :starts_at

#warnings ⇒ Array<Warnings>

Warnings associated with the access code.

Returns:



128
 
# File 'lib/seam/resources/unmanaged_access_code.rb', line 128

resource_list_accessor :warnings, Warnings