permabots.views.api package

Submodules

permabots.views.api.base module

class permabots.views.api.base.DetailBotAPIView(**kwargs)[source]

Bases: permabots.views.api.base.PermabotsAPIView

delete(request, bot_pk, pk, format=None)[source]
get(request, bot_pk, pk, format=None)[source]
get_object(pk, bot, user)[source]
model = None
put(request, bot_pk, pk, format=None)[source]
serializer = None
serializer_update = None
class permabots.views.api.base.ListBotAPIView(**kwargs)[source]

Bases: permabots.views.api.base.PermabotsAPIView

get(request, bot_pk, format=None)[source]
many = True
post(request, bot_pk, format=None)[source]
serializer = None
class permabots.views.api.base.ObjectBotListView(**kwargs)[source]

Bases: permabots.views.api.base.PermabotsAPIView

get(request, bot_pk, pk, format=None)[source]
get_object(pk, bot, user)[source]
obj_model = None
post(request, bot_pk, pk, format=None)[source]
serializer = None
class permabots.views.api.base.PermabotsAPIView(**kwargs)[source]

Bases: rest_framework.views.APIView

authentication_classes = (<class 'rest_framework.authentication.TokenAuthentication'>,)
get_bot(pk, user)[source]
permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)

permabots.views.api.bot module

class permabots.views.api.bot.BotDetail(**kwargs)[source]

Bases: permabots.views.api.base.PermabotsAPIView

delete(request, id, format=None)[source]

Delete an existing bot — responseMessages:

  • code: 401 message: Not authenticated
get(request, id, format=None)[source]

Get bot by id — serializer: BotSerializer responseMessages:

  • code: 401 message: Not authenticated
put(request, id, format=None)[source]

Update an existing bot — serializer: BotUpdateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
class permabots.views.api.bot.BotList(**kwargs)[source]

Bases: permabots.views.api.base.PermabotsAPIView

get(request, format=None)[source]

Get list of bots — serializer: BotSerializer responseMessages:

  • code: 401 message: Not authenticated
post(request, format=None)[source]

Add a new bot — serializer: BotSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
class permabots.views.api.bot.KikBotDetail(**kwargs)[source]

Bases: permabots.views.api.base.DetailBotAPIView

delete(request, bot_id, id, format=None)[source]

Delete existing Kik Bot — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, id, format=None)[source]

Get KikBot by id — serializer: KikBotSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of KikBot

put(request, bot_id, id, format=None)[source]

Update existing KikBot — serializer: KikBotUpdateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of KikBotSerializer

serializer_update

alias of KikBotUpdateSerializer

class permabots.views.api.bot.KikBotList(**kwargs)[source]

Bases: permabots.views.api.base.ListBotAPIView

get(request, bot_id, format=None)[source]

Get list of Kik bots — serializer: KikBotSerializer responseMessages:

  • code: 401 message: Not authenticated
many = False
post(request, bot_id, format=None)[source]

Add KIkBot — serializer: KikBotSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of KikBotSerializer

class permabots.views.api.bot.MessengerBotDetail(**kwargs)[source]

Bases: permabots.views.api.base.DetailBotAPIView

delete(request, bot_id, id, format=None)[source]

Delete existing Messenger Bot — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, id, format=None)[source]

Get MessengerBot by id — serializer: MessengerBotSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of MessengerBot

put(request, bot_id, id, format=None)[source]

Update existing MessengerBot — serializer: MessengerBotUpdateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of MessengerBotSerializer

serializer_update

alias of MessengerBotUpdateSerializer

class permabots.views.api.bot.MessengerBotList(**kwargs)[source]

Bases: permabots.views.api.base.ListBotAPIView

get(request, bot_id, format=None)[source]

Get list of Messenger bots — serializer: MessengerBotSerializer responseMessages:

  • code: 401 message: Not authenticated
many = False
post(request, bot_id, format=None)[source]

Add MessengerBot — serializer: MessengerBotSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of MessengerBotSerializer

class permabots.views.api.bot.TelegramBotDetail(**kwargs)[source]

Bases: permabots.views.api.base.DetailBotAPIView

delete(request, bot_id, id, format=None)[source]

Delete existing Telegram Bot — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, id, format=None)[source]

Get TelegramBot by id — serializer: TelegramBotSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of TelegramBot

put(request, bot_id, id, format=None)[source]

Update existing TelegramBot — serializer: TelegramBotUpdateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of TelegramBotSerializer

serializer_update

alias of TelegramBotUpdateSerializer

class permabots.views.api.bot.TelegramBotList(**kwargs)[source]

Bases: permabots.views.api.base.ListBotAPIView

get(request, bot_id, format=None)[source]

Get list of Telegram bots — serializer: TelegramBotSerializer responseMessages:

  • code: 401 message: Not authenticated
many = False
post(request, bot_id, format=None)[source]

Add TelegramBot — serializer: TelegramBotSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of TelegramBotSerializer

permabots.views.api.environment_vars module

class permabots.views.api.environment_vars.EnvironmentVarDetail(**kwargs)[source]

Bases: permabots.views.api.base.DetailBotAPIView

delete(request, bot_id, id, format=None)[source]

Delete existing environment variable — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, id, format=None)[source]

Get environment variable by id — serializer: EnvironmentVarSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of EnvironmentVar

put(request, bot_id, id, format=None)[source]

Update existing environment variable — serializer: EnvironmentVarSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of EnvironmentVarSerializer

class permabots.views.api.environment_vars.EnvironmentVarList(**kwargs)[source]

Bases: permabots.views.api.base.ListBotAPIView

get(request, bot_id, format=None)[source]

Get list of environment variables — serializer: EnvironmentVarSerializer responseMessages:

  • code: 401 message: Not authenticated
post(request, bot_id, format=None)[source]

Add a new environment variable — serializer: EnvironmentVarSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of EnvironmentVarSerializer

permabots.views.api.handler module

class permabots.views.api.handler.FromHandlerViewMixin[source]

Bases: object

get_handler(id, bot, user)[source]
class permabots.views.api.handler.HandlerDetail(**kwargs)[source]

Bases: permabots.views.api.base.DetailBotAPIView

delete(request, bot_id, id, format=None)[source]

Delete existing handler — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, id, format=None)[source]

Get handler by id — serializer: HandlerSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of Handler

put(request, bot_id, id, format=None)[source]

Update existing handler — serializer: HandlerUpdateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of HandlerSerializer

serializer_update

alias of HandlerUpdateSerializer

class permabots.views.api.handler.HandlerList(**kwargs)[source]

Bases: permabots.views.api.base.ListBotAPIView

get(request, bot_id, format=None)[source]

Get list of handlers — serializer: HandlerSerializer responseMessages:

  • code: 401 message: Not authenticated
post(request, bot_id, format=None)[source]

Add a new handler — serializer: HandlerSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of HandlerSerializer

class permabots.views.api.handler.HeaderParameterDetail(**kwargs)[source]

Bases: permabots.views.api.handler.RequestDetailView

delete(request, bot_id, handler_id, id, format=None)[source]

Delete an existing header parameter — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, handler_id, id, format=None)[source]

Get header parameter by id — serializer: AbsParamSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of HeaderParam

put(request, bot_id, handler_id, id, format=None)[source]

Update an existing header parameter — serializer: AbsParamSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of AbsParamSerializer

class permabots.views.api.handler.HeaderParameterList(**kwargs)[source]

Bases: permabots.views.api.base.ObjectBotListView

get(request, bot_id, id, format=None)[source]

Get list of header parameters of a handler — serializer: AbsParamSerializer responseMessages:

  • code: 401 message: Not authenticated
obj_model

alias of Handler

post(request, bot_id, id, format=None)[source]

Add a new header parameter to a handler — serializer: AbsParamSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of AbsParamSerializer

class permabots.views.api.handler.RequestDetailView(**kwargs)[source]

Bases: permabots.views.api.base.PermabotsAPIView

delete(request, bot_id, handler_id, id, format=None)[source]
get(request, bot_id, handler_id, id, format=None)[source]
get_handler(id, bot, user)[source]
get_object(id, handler, user)[source]
model = None
put(request, bot_id, handler_id, id, format=None)[source]
serializer = None
class permabots.views.api.handler.SourceStateDetail(**kwargs)[source]

Bases: permabots.views.api.handler.RequestDetailView

delete(request, bot_id, handler_id, id, format=None)[source]

Delete an existing source state — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, handler_id, id, format=None)[source]

Get source state by id — serializer: StateSerializer responseMessages:

  • code: 401 message: Not authenticated
get_object(id, handler, user)[source]
model

alias of State

put(request, bot_id, handler_id, id, format=None)[source]

Update an existing source state — serializer: StateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of StateSerializer

class permabots.views.api.handler.SourceStateList(**kwargs)[source]

Bases: permabots.views.api.base.ObjectBotListView

get(request, bot_id, id, format=None)[source]

Get list of source state of a handler — serializer: StateSerializer responseMessages:

  • code: 401 message: Not authenticated
obj_model

alias of Handler

post(request, bot_id, id, format=None)[source]

Add a new source state to a handler — serializer: StateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of StateSerializer

class permabots.views.api.handler.UrlParameterDetail(**kwargs)[source]

Bases: permabots.views.api.handler.RequestDetailView

delete(request, bot_id, handler_id, id, format=None)[source]

Delete an existing url parameter — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, handler_id, id, format=None)[source]

Get url parameter by id — serializer: AbsParamSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of UrlParam

put(request, bot_id, handler_id, id, format=None)[source]

Update an existing url parameter — serializer: AbsParamSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of AbsParamSerializer

class permabots.views.api.handler.UrlParameterList(**kwargs)[source]

Bases: permabots.views.api.base.ObjectBotListView

get(request, bot_id, id, format=None)[source]

Get list of url parameters of a handler — serializer: AbsParamSerializer responseMessages:

  • code: 401 message: Not authenticated
obj_model

alias of Handler

post(request, bot_id, id, format=None)[source]

Add a new url parameter to a handler — serializer: AbsParamSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of AbsParamSerializer

permabots.views.api.hook module

class permabots.views.api.hook.HookDetail(**kwargs)[source]

Bases: permabots.views.api.base.DetailBotAPIView

delete(request, bot_id, id, format=None)[source]

Delete existing hook — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, id, format=None)[source]

Get hook by id — serializer: HookSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of Hook

put(request, bot_id, id, format=None)[source]

Update existing hook — serializer: HookUpdateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of HookSerializer

serializer_update

alias of HookUpdateSerializer

class permabots.views.api.hook.HookList(**kwargs)[source]

Bases: permabots.views.api.base.ListBotAPIView

get(request, bot_id, format=None)[source]

Get list of hooks — serializer: HookSerializer responseMessages:

  • code: 401 message: Not authenticated
post(request, bot_id, format=None)[source]

Add a new hook — serializer: HookSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of HookSerializer

class permabots.views.api.hook.KikRecipientDetail(**kwargs)[source]

Bases: permabots.views.api.base.PermabotsAPIView

delete(request, bot_id, hook_id, id, format=None)[source]

Delete an existing kik recipient — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, hook_id, id, format=None)[source]

Get recipient by id — serializer: KikRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
get_hook(id, bot, user)[source]
get_recipient(id, hook, user)[source]
model

alias of KikRecipient

put(request, bot_id, hook_id, id, format=None)[source]

Update existing telegram recipient — serializer: KikRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of KikRecipientSerializer

class permabots.views.api.hook.KikRecipientList(**kwargs)[source]

Bases: permabots.views.api.base.ObjectBotListView

get(request, bot_id, id, format=None)[source]

Get list of kik recipients of a hook — serializer: KikRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
obj_model

alias of Hook

post(request, bot_id, id, format=None)[source]

Add a new kik recipient to a handler — serializer: KikRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of KikRecipientSerializer

class permabots.views.api.hook.MessengerRecipientDetail(**kwargs)[source]

Bases: permabots.views.api.base.PermabotsAPIView

delete(request, bot_id, hook_id, id, format=None)[source]

Delete an existing Messenger recipient — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, hook_id, id, format=None)[source]

Get recipient by id — serializer: MessengerRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
get_hook(id, bot, user)[source]
get_recipient(id, hook, user)[source]
model

alias of MessengerRecipient

put(request, bot_id, hook_id, id, format=None)[source]

Update existing telegram recipient — serializer: MessengerRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of MessengerRecipientSerializer

class permabots.views.api.hook.MessengerRecipientList(**kwargs)[source]

Bases: permabots.views.api.base.ObjectBotListView

get(request, bot_id, id, format=None)[source]

Get list of Messenger recipients of a hook — serializer: MessengerRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
obj_model

alias of Hook

post(request, bot_id, id, format=None)[source]

Add a new messenger recipient to a handler — serializer: MessengerRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of MessengerRecipientSerializer

class permabots.views.api.hook.TelegramRecipientDetail(**kwargs)[source]

Bases: permabots.views.api.base.PermabotsAPIView

delete(request, bot_id, hook_id, id, format=None)[source]

Delete an existing telegram recipient — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, hook_id, id, format=None)[source]

Get recipient by id — serializer: TelegramRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
get_hook(id, bot, user)[source]
get_recipient(id, hook, user)[source]
model

alias of TelegramRecipient

put(request, bot_id, hook_id, id, format=None)[source]

Update existing telegram recipient — serializer: TelegramRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of TelegramRecipientSerializer

class permabots.views.api.hook.TelegramRecipientList(**kwargs)[source]

Bases: permabots.views.api.base.ObjectBotListView

get(request, bot_id, id, format=None)[source]

Get list of telegram recipients of a hook — serializer: TelegramRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
obj_model

alias of Hook

post(request, bot_id, id, format=None)[source]

Add a new telegram recipient to a handler — serializer: TelegramRecipientSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of TelegramRecipientSerializer

permabots.views.api.state module

class permabots.views.api.state.BaseChatStateDetail(**kwargs)[source]

Bases: permabots.views.api.base.PermabotsAPIView

delete(request, bot_id, id, format=None)[source]
get(request, bot_id, id, format=None)[source]
get_object(id, bot, user)[source]
model = None
put(request, bot_id, id, format=None)[source]
serializer = None
serializer_update = None
class permabots.views.api.state.BaseChatStateList(**kwargs)[source]

Bases: permabots.views.api.base.ListBotAPIView

chat_model = None
get(request, bot_id, format=None)[source]
get_chat(bot, data)[source]
get_state(bot, data)[source]
get_user(bot, data)[source]
model = None
post(request, bot_id, format=None)[source]
serializer = None
user_model = None
class permabots.views.api.state.KikChatStateDetail(**kwargs)[source]

Bases: permabots.views.api.state.BaseChatStateDetail

delete(request, bot_id, id, format=None)[source]

Delete existing Kik chat state — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, id, format=None)[source]

Get Kik chat state by id — serializer: KikChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of KikChatState

put(request, bot_id, id, format=None)[source]

Update existing Kik chat state — serializer: KikChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of KikChatStateSerializer

serializer_update

alias of KikChatStateUpdateSerializer

class permabots.views.api.state.KikChatStateList(**kwargs)[source]

Bases: permabots.views.api.state.BaseChatStateList

chat_model

alias of KikChat

get(request, bot_id, format=None)[source]

Get list of chat state — serializer: KikChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of KikChatState

post(request, bot_id, format=None)[source]

Add a new chat state — serializer: KikChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of KikChatStateSerializer

user_model

alias of KikUser

class permabots.views.api.state.MessengerChatStateDetail(**kwargs)[source]

Bases: permabots.views.api.state.BaseChatStateDetail

delete(request, bot_id, id, format=None)[source]

Delete existing Messenger chat state — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, id, format=None)[source]

Get Messenger chat state by id — serializer: MessengerChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of MessengerChatState

put(request, bot_id, id, format=None)[source]

Update existing Messenger chat state — serializer: MessengerChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of MessengerChatStateSerializer

serializer_update

alias of MessengerChatStateUpdateSerializer

class permabots.views.api.state.MessengerChatStateList(**kwargs)[source]

Bases: permabots.views.api.state.BaseChatStateList

get(request, bot_id, format=None)[source]

Get list of chat state — serializer: MessengerChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of MessengerChatState

post(request, bot_id, format=None)[source]

Add a new chat state — serializer: MessengerChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of MessengerChatStateSerializer

class permabots.views.api.state.StateDetail(**kwargs)[source]

Bases: permabots.views.api.base.DetailBotAPIView

delete(request, bot_id, id, format=None)[source]

Delete existing state — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, id, format=None)[source]

Get state by id — serializer: StateSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of State

put(request, bot_id, id, format=None)[source]

Update existing state — serializer: StateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of StateSerializer

class permabots.views.api.state.StateList(**kwargs)[source]

Bases: permabots.views.api.base.ListBotAPIView

get(request, bot_id, format=None)[source]

Get list of states — serializer: StateSerializer responseMessages:

  • code: 401 message: Not authenticated
post(request, bot_id, format=None)[source]

Add a new state — serializer: StateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of StateSerializer

class permabots.views.api.state.TelegramChatStateDetail(**kwargs)[source]

Bases: permabots.views.api.state.BaseChatStateDetail

delete(request, bot_id, id, format=None)[source]

Delete existing Kik chat state — responseMessages:

  • code: 401 message: Not authenticated
get(request, bot_id, id, format=None)[source]

Get Telegram chat state by id — serializer: TelegramChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of TelegramChatState

put(request, bot_id, id, format=None)[source]

Update existing Telegram chat state — serializer: TelegramChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of TelegramChatStateSerializer

serializer_update

alias of TelegramChatStateUpdateSerializer

class permabots.views.api.state.TelegramChatStateList(**kwargs)[source]

Bases: permabots.views.api.state.BaseChatStateList

chat_model

alias of Chat

get(request, bot_id, format=None)[source]

Get list of chat state — serializer: TelegramChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
model

alias of TelegramChatState

post(request, bot_id, format=None)[source]

Add a new chat state — serializer: TelegramChatStateSerializer responseMessages:

  • code: 401 message: Not authenticated
  • code: 400 message: Not valid request
serializer

alias of TelegramChatStateSerializer

user_model

alias of User

Module contents