@type auth_credentials() ::
  {:auth_credentials, username :: String.t(), password_hash :: String.t()}

@type auth_result() :: {:ok, oauth_response()} | {:error, oauth_error() | atom()}

@type client_config() ::
  {:client_config, client_id :: String.t(), client_secret :: String.t(),
   base_url :: String.t()}

@type lock_api_result() ::
  {:ok, lock_list_response() | lock_detail_response()}
  | {:error, oauth_error() | atom()}

@type lock_detail_params() :: {:lock_detail_params, lock_id :: integer()}

@type lock_detail_response() :: %{
  lockId: integer(),
  lockName: String.t(),
  lockAlias: String.t(),
  lockMac: String.t(),
  noKeyPwd: String.t(),
  electricQuantity: integer(),
  featureValue: String.t(),
  timezoneRawOffset: integer(),
  modelNum: String.t(),
  hardwareRevision: String.t(),
  firmwareRevision: String.t(),
  autoLockTime: integer(),
  lockSound: integer(),
  privacyLock: integer(),
  tamperAlert: integer(),
  resetButton: integer(),
  openDirection: integer(),
  passageMode: integer(),
  passageModeAutoUnlock: integer(),
  date: integer()
}

@type lock_list_params() ::
  {:lock_list_params, page_no :: integer(), page_size :: integer(),
   lock_alias :: String.t() | nil, group_id :: integer() | nil}

@type lock_list_response() :: %{
  list: [lock_record()],
  pageNo: integer(),
  pageSize: integer(),
  pages: integer(),
  total: integer()
}

@type lock_record() :: %{
  lockId: integer(),
  lockName: String.t(),
  lockAlias: String.t(),
  lockMac: String.t(),
  electricQuantity: integer(),
  featureValue: String.t(),
  hasGateway: integer(),
  lockData: String.t(),
  groupId: integer(),
  groupName: String.t(),
  date: integer()
}

@type oauth_error() :: %{error_code: integer(), description: String.t()}

@type oauth_response() :: %{
  access_token: String.t(),
  refresh_token: String.t(),
  expires_in: integer(),
  uid: integer()
}

@type passcode_add_params() ::
  {:passcode_add_params, lock_id :: integer(), keyboard_pwd :: integer(),
   keyboard_pwd_name :: String.t() | nil, keyboard_pwd_type :: integer(),
   start_date :: integer() | nil, end_date :: integer() | nil,
   add_type :: integer()}

@type passcode_add_response() :: %{keyboardPwdId: integer()}

@type passcode_api_result() ::
  {:ok,
   passcode_add_response()
   | passcode_list_response()
   | passcode_delete_response()
   | passcode_change_response()}
  | {:error, oauth_error() | atom()}

@type passcode_change_params() ::
  {:passcode_change_params, lock_id :: integer(), keyboard_pwd_id :: integer(),
   keyboard_pwd_name :: String.t() | nil, new_keyboard_pwd :: integer() | nil,
   start_date :: integer() | nil, end_date :: integer() | nil,
   change_type :: integer()}

@type passcode_change_response() :: %{errcode: integer(), errmsg: String.t()}

@type passcode_delete_params() ::
  {:passcode_delete_params, lock_id :: integer(), keyboard_pwd_id :: integer()}

@type passcode_delete_response() :: %{errcode: integer(), errmsg: String.t()}

@type passcode_list_params() ::
  {:passcode_list_params, lock_id :: integer(), search_str :: String.t() | nil,
   page_no :: integer(), page_size :: integer(), order_by :: integer()}

@type passcode_list_response() :: %{
  list: [passcode_record()],
  pageNo: integer(),
  pageSize: integer(),
  pages: integer(),
  total: integer()
}

@type passcode_record() :: %{
  keyboardPwdId: integer(),
  lockId: integer(),
  keyboardPwd: String.t(),
  keyboardPwdName: String.t(),
  keyboardPwdType: String.t(),
  startDate: integer(),
  endDate: integer(),
  sendDate: integer(),
  isCustom: integer(),
  senderUsername: String.t()
}

@type token_info() ::
  {:token_info, access_token :: String.t() | nil,
   refresh_token :: String.t() | nil, expires_at :: DateTime.t() | nil,
   uid :: integer() | nil}