Class: Seam::Resources::SeamEvent

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

Overview

Represents a Seam event. Known event types load as subclasses; unknown event types remain SeamEvent instances for forward compatibility.

Defined Under Namespace

Classes: AccessCodeBackupAccessCodePulled, AccessCodeChanged, AccessCodeCodeChanged, AccessCodeCreated, AccessCodeDelayInRemovingFromDevice, AccessCodeDelayInSettingOnDevice, AccessCodeDeleted, AccessCodeDeletedExternalToSeam, AccessCodeFailedToRemoveFromDevice, AccessCodeFailedToSetOnDevice, AccessCodeModifiedExternalToSeam, AccessCodeMutationsRequested, AccessCodeNameChanged, AccessCodeRemovedFromDevice, AccessCodeScheduledOnDevice, AccessCodeSetOnDevice, AccessCodeTimeFrameChanged, AccessCodeUnmanagedConvertedToManaged, AccessCodeUnmanagedCreated, AccessCodeUnmanagedFailedToConvertToManaged, AccessCodeUnmanagedRemoved, AccessGrantAccessGrantedToAllDoors, AccessGrantAccessGrantedToDoor, AccessGrantAccessTimesChanged, AccessGrantAccessToDoorLost, AccessGrantCouldNotCreateRequestedAccessMethods, AccessGrantCreated, AccessGrantDeleted, AccessMethodCardEncodingRequired, AccessMethodCreated, AccessMethodDelayInIssuing, AccessMethodDeleted, AccessMethodFailedToIssue, AccessMethodIssued, AccessMethodReissued, AccessMethodRevoked, AcsAccessGroupDeleted, AcsCredentialDeleted, AcsCredentialInvalidated, AcsCredentialIssued, AcsCredentialReissued, AcsEncoderAdded, AcsEncoderRemoved, AcsEntranceAdded, AcsEntranceRemoved, AcsSystemAdded, AcsSystemConnected, AcsSystemDisconnected, AcsUserCreated, AcsUserDeleted, ActionAttemptLockDoorFailed, ActionAttemptLockDoorSucceeded, ActionAttemptSimulateKeypadCodeEntryFailed, ActionAttemptSimulateKeypadCodeEntrySucceeded, ActionAttemptSimulateManualLockViaKeypadFailed, ActionAttemptSimulateManualLockViaKeypadSucceeded, ActionAttemptUnlockDoorFailed, ActionAttemptUnlockDoorSucceeded, CameraActivated, ClientSessionDeleted, ConnectWebviewLoginFailed, ConnectWebviewLoginSucceeded, ConnectedAccountCompletedFirstSync, ConnectedAccountCompletedFirstSyncAfterReconnection, ConnectedAccountConnected, ConnectedAccountCreated, ConnectedAccountDeleted, ConnectedAccountDisconnected, ConnectedAccountReauthorizationRequested, ConnectedAccountSuccessfulLogin, DeviceAccessoryKeypadConnected, DeviceAccessoryKeypadDisconnected, DeviceAdded, DeviceBatteryStatusChanged, DeviceConnected, DeviceConnectionBecameFlaky, DeviceConnectionStabilized, DeviceConvertedToUnmanaged, DeviceDeleted, DeviceDisconnected, DeviceDoorbellRang, DeviceErrorSubscriptionRequired, DeviceErrorSubscriptionRequiredResolved, DeviceLowBattery, DeviceNameChanged, DeviceRemoved, DeviceSaltoPrivacyModeActivated, DeviceSaltoPrivacyModeDeactivated, DeviceTampered, DeviceThirdPartyIntegrationDetected, DeviceThirdPartyIntegrationNoLongerDetected, DeviceUnmanagedConnected, DeviceUnmanagedConvertedToManaged, DeviceUnmanagedDisconnected, LockAccessDenied, LockLocked, LockUnlocked, NoiseSensorNoiseThresholdTriggered, PhoneDeactivated, SpaceCreated, SpaceDeleted, SpaceDeviceMembershipChanged, ThermostatClimatePresetActivated, ThermostatManuallyAdjusted, ThermostatTemperatureChanged, ThermostatTemperatureReachedSetPoint, ThermostatTemperatureThresholdExceeded, ThermostatTemperatureThresholdNoLongerExceeded

Instance Attribute Summary collapse

Attributes inherited from BaseResource

#client, #data

Instance Method Summary collapse

Methods inherited from BaseResource

#[], aliased_accessor, attribute_aliases, date_accessor, discriminated_by, #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

#event_description ⇒ String?

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

Returns:

  • (String, nil) 


5072
5073
5074
 
# File 'lib/seam/resources/event.rb', line 5072

def event_description
  @event_description
end

#event_id ⇒ String?

ID of the event.

Returns:

  • (String, nil) 


5075
5076
5077
 
# File 'lib/seam/resources/event.rb', line 5075

def event_id
  @event_id
end

#event_type ⇒ String?

Known values:

  • access_code.created
  • access_code.changed
  • access_code.name_changed
  • access_code.code_changed
  • access_code.time_frame_changed
  • access_code.mutations_requested
  • access_code.scheduled_on_device
  • access_code.set_on_device
  • access_code.removed_from_device
  • access_code.delay_in_setting_on_device
  • access_code.failed_to_set_on_device
  • access_code.issued
  • access_code.delay_in_issuing
  • access_code.failed_to_issue
  • access_code.failed_to_update
  • access_code.failed_to_expire
  • access_code.deleted
  • access_code.delay_in_removing_from_device
  • access_code.failed_to_remove_from_device
  • access_code.modified_external_to_seam
  • access_code.deleted_external_to_seam
  • access_code.backup_access_code_pulled
  • access_code.unmanaged.converted_to_managed
  • access_code.unmanaged.failed_to_convert_to_managed
  • access_code.unmanaged.created
  • access_code.unmanaged.removed
  • access_grant.created
  • access_grant.deleted
  • access_grant.access_granted_to_all_doors
  • access_grant.access_granted_to_door
  • access_grant.access_to_door_lost
  • access_grant.access_times_changed
  • access_grant.could_not_create_requested_access_methods
  • access_method.issued
  • access_method.revoked
  • access_method.card_encoding_required
  • access_method.deleted
  • access_method.reissued
  • access_method.created
  • access_method.delay_in_issuing
  • access_method.failed_to_issue
  • acs_system.connected
  • acs_system.added
  • acs_system.disconnected
  • acs_credential.deleted
  • acs_credential.issued
  • acs_credential.reissued
  • acs_credential.invalidated
  • acs_user.created
  • acs_user.deleted
  • acs_encoder.added
  • acs_encoder.removed
  • acs_access_group.deleted
  • acs_entrance.added
  • acs_entrance.removed
  • client_session.deleted
  • connected_account.connected
  • connected_account.created
  • connected_account.successful_login
  • connected_account.disconnected
  • connected_account.completed_first_sync
  • connected_account.deleted
  • connected_account.completed_first_sync_after_reconnection
  • connected_account.reauthorization_requested
  • action_attempt.lock_door.succeeded
  • action_attempt.lock_door.failed
  • action_attempt.unlock_door.succeeded
  • action_attempt.unlock_door.failed
  • action_attempt.simulate_keypad_code_entry.succeeded
  • action_attempt.simulate_keypad_code_entry.failed
  • action_attempt.simulate_manual_lock_via_keypad.succeeded
  • action_attempt.simulate_manual_lock_via_keypad.failed
  • connect_webview.login_succeeded
  • connect_webview.login_failed
  • device.connected
  • device.added
  • device.converted_to_unmanaged
  • device.unmanaged.converted_to_managed
  • device.unmanaged.connected
  • device.disconnected
  • device.unmanaged.disconnected
  • device.tampered
  • device.low_battery
  • device.battery_status_changed
  • device.removed
  • device.deleted
  • device.third_party_integration_detected
  • device.third_party_integration_no_longer_detected
  • device.salto.privacy_mode_activated
  • device.salto.privacy_mode_deactivated
  • device.connection_became_flaky
  • device.connection_stabilized
  • device.error.subscription_required
  • device.error.subscription_required.resolved
  • device.accessory_keypad_connected
  • device.accessory_keypad_disconnected
  • noise_sensor.noise_threshold_triggered
  • lock.locked
  • lock.unlocked
  • lock.access_denied
  • thermostat.climate_preset_activated
  • thermostat.manually_adjusted
  • thermostat.temperature_threshold_exceeded
  • thermostat.temperature_threshold_no_longer_exceeded
  • thermostat.temperature_reached_set_point
  • thermostat.temperature_changed
  • device.name_changed
  • camera.activated
  • device.doorbell_rang
  • enrollment_automation.deleted
  • phone.deactivated
  • space.device_membership_changed
  • space.created
  • space.deleted

Returns:

  • (String, nil) 


5192
5193
5194
 
# File 'lib/seam/resources/event.rb', line 5192

def event_type
  @event_type
end

#workspace_id ⇒ String?

ID of the workspace associated with the event.

Returns:

  • (String, nil) 


5195
5196
5197
 
# File 'lib/seam/resources/event.rb', line 5195

def workspace_id
  @workspace_id
end

Instance Method Details

#created_at ⇒ Time?

Date and time at which the event was created.

Returns:

  • (Time, nil) 


5199
 
# File 'lib/seam/resources/event.rb', line 5199

date_accessor :created_at

#occurred_at ⇒ Time?

Date and time at which the event occurred.

Returns:

  • (Time, nil) 


5203
 
# File 'lib/seam/resources/event.rb', line 5203

date_accessor :occurred_at