Add voucher remove function

custom_components/unifi_voucher/__init__.py

@@ -13,6 +13,10 @@
  PLATFORMS,
 )
 from .coordinator import UnifiVoucherCoordinator
+from .api import (
+ UnifiVoucherApiAuthenticationError,
+ UnifiVoucherApiAccessError,
+)
 
 
 async def async_setup(hass: HomeAssistant, config: dict) -> bool:
@@ -34,15 +38,20 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> b
  await coordinator.initialize()
  await coordinator.async_config_entry_first_refresh()
 
- except AuthenticationRequired as err:
+ except (
+ UnifiVoucherApiAuthenticationError,
+ UnifiVoucherApiAccessError,
+ ) as err:
  raise ConfigEntryAuthFailed from err
 
  except Exception as err:
  raise ConfigEntryNotReady from err
 
  hass.data[DOMAIN][config_entry.entry_id] = coordinator
  await hass.config_entries.async_forward_entry_setups(config_entry, PLATFORMS)
- config_entry.async_on_unload(config_entry.add_update_listener(async_reload_entry))
+ config_entry.async_on_unload(
+ config_entry.add_update_listener(async_reload_entry)
+ )
 
  return True
 

custom_components/unifi_voucher/api.py

@@ -3,7 +3,10 @@
 
 import asyncio
 from dataclasses import dataclass
-from typing import TypedDict
+from typing import (
+ Self,
+ TypedDict,
+)
 
 from datetime import (
  timedelta,
@@ -78,7 +81,7 @@ class UnifiVoucherListRequest(ApiRequest):
  @classmethod
  def create(
  cls
- ) -> self:
+ ) -> Self:
  """Create voucher list request."""
  return cls(
  method="get",
@@ -100,7 +103,7 @@ def create(
  down_bandwidth: int | None = None,
  byte_quota: int | None = None,
  note: str | None = None,
- ) -> self:
+ ) -> Self:
  """
  Create voucher create request.
 
@@ -130,7 +133,30 @@ def create(
  data["bytes"] = byte_quota
  if note:
  data["note"] = note
-
+
+ return cls(
+ method="post",
+ path="/cmd/hotspot",
+ data=data,
+ )
+
+
+@dataclass
+class UnifiVoucherRemoveRequest(ApiRequest):
+ """Request object for voucher create."""
+
+ @classmethod
+ def create(
+ cls,
+ obj_id: int,
+ ) -> Self:
+ """
+ Create voucher remove request.
+ """
+ data = {
+ "cmd": "delete-voucher",
+ "_id": obj_id,
+ }
  return cls(
  method="post",
  path="/cmd/hotspot",

custom_components/unifi_voucher/button.py

@@ -60,6 +60,13 @@ async def async_setup_entry(
  device_class=ButtonDeviceClass.RESTART,
  press_action=lambda coordinator: coordinator.async_create_voucher(),
  ),
+ UnifiVoucherButtonDescription(
+ key="remove",
+ icon="mdi:numeric-negative-1",
+ translation_key="remove",
+ device_class=ButtonDeviceClass.RESTART,
+ press_action=lambda coordinator: coordinator.async_remove_voucher(),
+ ),
  ]
 
  async_add_entities(

custom_components/unifi_voucher/coordinator.py

@@ -29,6 +29,7 @@
  UnifiVoucherApiClient,
  UnifiVouchers,
  UnifiVoucherCreateRequest,
+ UnifiVoucherRemoveRequest,
  UnifiVoucherApiAuthenticationError,
  UnifiVoucherApiAccessError,
  UnifiVoucherApiConnectionError,
@@ -194,15 +195,24 @@ async def async_update_vouchers(
 
  async def async_create_voucher(
  self,
- number: int = 1,
- quota: int = 1,
- expire: int = 480,
+ number: int | None = None,
+ quota: int | None = None,
+ expire: int | None = None,
  up_bandwidth: int | None = None,
  down_bandwidth: int | None = None,
  byte_quota: int | None = None,
  ) -> None:
  """Create new voucher."""
  try:
+ if number is None:
+ number = 1 # TODO
+
+ if quota is None:
+ quota = 1 # TODO
+
+ if expire is None:
+ expire = 480 # TODO
+
  await self.client.controller.request(
  UnifiVoucherCreateRequest.create(
  number=number,
@@ -217,3 +227,23 @@ async def async_create_voucher(
  await self.async_update_vouchers()
  except Exception as exception:
  LOGGER.exception(exception)
+
+ async def async_remove_voucher(
+ self,
+ obj_id: int | None = None,
+ ) -> None:
+ """Remove voucher."""
+ try:
+ # No voucher ID given
+ if obj_id is None:
+ if (obj_id := self.last_voucher_id) is None:
+ raise ValueError
+
+ await self.client.controller.request(
+ UnifiVoucherRemoveRequest.create(
+ obj_id=obj_id,
+ )
+ )
+ await self.async_update_vouchers()
+ except Exception as exception:
+ LOGGER.exception(exception)

custom_components/unifi_voucher/strings.json

@@ -51,6 +51,14 @@
  "name": "Last pull"
  }
  }
+ },
+ "remove": {
+ "name": "Delete voucher",
+ "state_attributes": {
+ "last_pull": {
+ "name": "Last pull"
+ }
+ }
  }
  },
  "sensor": {