Class: Seam::Resources::ActionAttempt

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

Overview

Represents a Seam action attempt. Known action types load as subclasses; unknown action types remain ActionAttempt instances for forward compatibility.

Defined Under Namespace

Classes: ActivateClimatePreset, AssignCredential, ConfigureAutoLock, CreateAccessCode, CreateNoiseThreshold, DeleteAccessCode, DeleteNoiseThreshold, EncodeCredential, Error, LockDoor, PushThermostatPrograms, ResetSandboxWorkspace, Result, ScanCredential, ScanToAssignCredential, SetFanMode, SetHvacMode, SimulateKeypadCodeEntry, SimulateManualLockViaKeypad, SyncAccessCodes, UnlockDoor, UpdateAccessCode, UpdateNoiseThreshold

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

#action_attempt_id ⇒ String

ID of the action attempt.

Returns:

  • (String) 


1630
1631
1632
 
# File 'lib/seam/resources/action_attempt.rb', line 1630

def action_attempt_id
  @action_attempt_id
end

#action_type ⇒ String

Known values:

  • LOCK_DOOR
  • UNLOCK_DOOR
  • SCAN_CREDENTIAL
  • ENCODE_CREDENTIAL
  • SCAN_TO_ASSIGN_CREDENTIAL
  • ASSIGN_CREDENTIAL
  • RESET_SANDBOX_WORKSPACE
  • SET_FAN_MODE
  • SET_HVAC_MODE
  • ACTIVATE_CLIMATE_PRESET
  • SIMULATE_KEYPAD_CODE_ENTRY
  • SIMULATE_MANUAL_LOCK_VIA_KEYPAD
  • PUSH_THERMOSTAT_PROGRAMS
  • CONFIGURE_AUTO_LOCK
  • SYNC_ACCESS_CODES
  • CREATE_ACCESS_CODE
  • DELETE_ACCESS_CODE
  • UPDATE_ACCESS_CODE
  • CREATE_NOISE_THRESHOLD
  • DELETE_NOISE_THRESHOLD
  • UPDATE_NOISE_THRESHOLD

Returns:

  • (String) 


1654
1655
1656
 
# File 'lib/seam/resources/action_attempt.rb', line 1654

def action_type
  @action_type
end

#status ⇒ String

Known values:

  • success
  • pending
  • error

Returns:

  • (String) 


1660
1661
1662
 
# File 'lib/seam/resources/action_attempt.rb', line 1660

def status
  @status
end

Instance Method Details

#error ⇒ Error?

Error associated with the action.

Returns:



1625
 
# File 'lib/seam/resources/action_attempt.rb', line 1625

resource_accessor :error, Error

#result ⇒ Result?

Returns:



1627
 
# File 'lib/seam/resources/action_attempt.rb', line 1627

resource_accessor :result, Result