# Describes the format for available SimpliSafe services

---
remove_pin:
  description: Remove a PIN by its label or value.
  fields:
    system_id:
      description: The SimpliSafe system ID to affect.
      example: 123987
    label_or_pin:
      description: The label/value to remove.
      example: Test PIN
set_pin:
  description: Set/update a PIN
  fields:
    system_id:
      description: The SimpliSafe system ID to affect
      example: 123987
    label:
      description: The label of the PIN
      example: Test PIN
    pin:
      description: The value of the PIN
      example: 1256
set_system_properties:
  description: Set one or more system properties
  fields:
    alarm_duration:
      description: The length of a triggered alarm
      example: 300
    alarm_volume:
      description: The volume level of a triggered alarm
      example: 2
    chime_volume:
      description: The volume level of the door chime
      example: 2
    entry_delay_away:
      description: How long to delay when entering while "away"
      example: 45
    entry_delay_home:
      description: How long to delay when entering while "home"
      example: 45
    exit_delay_away:
      description: How long to delay when exiting while "away"
      example: 45
    exit_delay_home:
      description: How long to delay when exiting while "home"
      example: 45
    light:
      description: Whether the armed light should be visible
      example: true
    voice_prompt_volume:
      description: The volume level of the voice prompt
      example: 2