kakaowork.client module

class kakaowork.client.AsyncKakaowork(*, app_key: str, base_url: Optional[str] = 'https://api.kakaowork.com')

Bases: object

class Batch(client: AsyncKakaowork, *, base_path: Optional[str] = '/v1/batch')

Bases: object

class Users(batch: Batch)

Bases: object

async reset_vacation_time(*, user_ids: List[int]) → BaseResponse

async reset_work_time(*, user_ids: List[int]) → BaseResponse

async set_vacation_time(items: List[VacationTimeField]) → BaseResponse

async set_work_time(items: List[WorkTimeField]) → BaseResponse

property users: Users

class Bots(client: AsyncKakaowork, *, base_path: Optional[str] = '/v1/bots')

Bases: object

async info() → BotResponse

class Conversations(client: AsyncKakaowork, *, base_path: Optional[str] = '/v1/conversations')

Bases: object

async invite(*, conversation_id: int, user_ids: List[int]) → BaseResponse

async kick(*, conversation_id: int, user_ids: List[int]) → BaseResponse

async list(*, cursor: Optional[str] = None, limit: Optional[int] = Limit.DEFAULT) → ConversationListResponse

async open(*, user_ids: List[int]) → ConversationResponse

async users(*, conversation_id: int) → UserListResponse

class Departments(client: AsyncKakaowork, *, base_path: Optional[str] = '/v1/departments')

Bases: object

async list(*, cursor: Optional[str] = None, limit: Optional[int] = Limit.DEFAULT) → DepartmentListResponse

class Messages(client: AsyncKakaowork, *, base_path: Optional[str] = '/v1/messages')

Bases: object

async send(*, conversation_id: int, text: str, blocks: Optional[List[Block]] = None) → MessageResponse

async send_by(*, text: str, email: Optional[str] = None, key: Optional[str] = None, blocks: Optional[List[Block]] = None) → MessageResponse

async send_by_email(email: str, *, text: str, blocks: Optional[List[Block]] = None) → MessageResponse

class Spaces(client: AsyncKakaowork, *, base_path: Optional[str] = '/v1/spaces')

Bases: object

async info() → SpaceResponse

class Users(client: AsyncKakaowork, *, base_path: Optional[str] = '/v1/users')

Bases: object

async find_by_email(email: str) → UserResponse

async find_by_phone_number(phone_number: str) → UserResponse

async info(*, user_id: int) → UserResponse

async list(*, cursor: Optional[str] = None, limit: Optional[int] = Limit.DEFAULT) → UserListResponse

async set_vacation_time(*, user_id: int, vacation_start_time: datetime, vacation_end_time: datetime) → BaseResponse

async set_work_time(*, user_id: int, work_start_time: datetime, work_end_time: datetime) → BaseResponse

property batch: Batch

property bots: Bots

property conversations: Conversations

property departments: Departments

property headers: Dict[str, Any]

property messages: Messages

property spaces: Spaces

property users: Users

class kakaowork.client.Kakaowork(*, app_key: str, base_url: Optional[str] = 'https://api.kakaowork.com')

Bases: object

class Batch(client: Kakaowork, *, base_path: Optional[str] = '/v1/batch')

Bases: object

class Users(batch: Batch)

Bases: object

reset_vacation_time(*, user_ids: List[int]) → BaseResponse

reset_work_time(*, user_ids: List[int]) → BaseResponse

set_vacation_time(items: List[VacationTimeField]) → BaseResponse

set_work_time(items: List[WorkTimeField]) → BaseResponse

property users: Users

class Bots(client: Kakaowork, *, base_path: Optional[str] = '/v1/bots')

Bases: object

info() → BotResponse

class Conversations(client: Kakaowork, *, base_path: Optional[str] = '/v1/conversations')

Bases: object

invite(*, conversation_id: int, user_ids: List[int]) → BaseResponse

kick(*, conversation_id: int, user_ids: List[int]) → BaseResponse

list(*, cursor: Optional[str] = None, limit: Optional[int] = Limit.DEFAULT) → ConversationListResponse

open(*, user_ids: List[int]) → ConversationResponse

users(*, conversation_id: int) → UserListResponse

class Departments(client: Kakaowork, *, base_path: Optional[str] = '/v1/departments')

Bases: object

list(*, cursor: Optional[str] = None, limit: Optional[int] = Limit.DEFAULT) → DepartmentListResponse

class Messages(client: Kakaowork, *, base_path: Optional[str] = '/v1/messages')

Bases: object

send(*, conversation_id: int, text: str, blocks: Optional[List[Block]] = None) → MessageResponse

send_by(*, text: str, email: Optional[str] = None, key: Optional[str] = None, blocks: Optional[List[Block]] = None) → MessageResponse

send_by_email(email: str, *, text: str, blocks: Optional[List[Block]] = None) → MessageResponse

class Spaces(client: Kakaowork, *, base_path: Optional[str] = '/v1/spaces')

Bases: object

info() → SpaceResponse

class Users(client: Kakaowork, *, base_path: Optional[str] = '/v1/users')

Bases: object

find_by_email(email: str) → UserResponse

find_by_phone_number(phone_number: str) → UserResponse

info(*, user_id: int) → UserResponse

list(*, cursor: Optional[str] = None, limit: Optional[int] = Limit.DEFAULT) → UserListResponse

set_vacation_time(*, user_id: int, vacation_start_time: datetime, vacation_end_time: datetime) → BaseResponse

set_work_time(*, user_id: int, work_start_time: datetime, work_end_time: datetime) → BaseResponse

property batch: Batch

property bots: Bots

property conversations: Conversations

property departments: Departments

property headers: Dict[str, Any]

property messages: Messages

property spaces: Spaces

property users: Users