kakaowork.blockkit module

class kakaowork.blockkit.ActionBlock(*, type: kakaowork.blockkit.BlockType, elements: List[kakaowork.blockkit.ButtonBlock])

Bases: kakaowork.blockkit.Block

elements: List[kakaowork.blockkit.ButtonBlock]
class kakaowork.blockkit.Block(*, type: kakaowork.blockkit.BlockType)

Bases: pydantic.main.BaseModel, abc.ABC

class Config

Bases: object

underscore_attrs_are_private = True
validate_assignment = True
classmethod new(value: Union[Dict, kakaowork.blockkit.Block]) → kakaowork.blockkit.Block
type: kakaowork.blockkit.BlockType
class kakaowork.blockkit.BlockKitBuilder(*, type: kakaowork.blockkit.BlockKitType, blocks: List[kakaowork.blockkit.Block] = [], text: str = None, title: str = None, accept: str = None, decline: str = None, value: str = None)

Bases: pydantic.main.BaseModel

class Config

Bases: object

validate_assignment = True
accept: Optional[str]
add_block(block: Union[kakaowork.blockkit.Block, dict])
blocks: List[kakaowork.blockkit.Block]
decline: Optional[str]
classmethod load(path: str) → kakaowork.blockkit.BlockKitBuilder
text: Optional[str]
title: Optional[str]
type: kakaowork.blockkit.BlockKitType
value: Optional[str]
class kakaowork.blockkit.BlockKitType(value)

Bases: kakaowork.consts.StrEnum

An enumeration.

MESSAGE = 'message'
MODAL = 'modal'
class kakaowork.blockkit.BlockType(value)

Bases: kakaowork.consts.StrEnum

An enumeration.

ACTION = 'action'
BUTTON = 'button'
CONTEXT = 'context'
DESCRIPTION = 'description'
DIVIDER = 'divider'
HEADER = 'header'
INPUT = 'input'
LABEL = 'label'
SECTION = 'section'
SELECT = 'select'
TEXT = 'text'
classmethod block_cls(type: Union[str, kakaowork.blockkit.BlockType]) → Type[kakaowork.blockkit.Block]
class kakaowork.blockkit.ButtonActionType(value)

Bases: kakaowork.consts.StrEnum

An enumeration.

CALL_MODAL = 'call_modal'
OPEN_EXTERNAL_APP = 'open_external_app'
OPEN_INAPP_BROWSER = 'open_inapp_browser'
OPEN_SYSTEM_BROWSER = 'open_system_browser'
SUBMIT_ACTION = 'submit_action'
class kakaowork.blockkit.ButtonBlock(*, type: kakaowork.blockkit.BlockType, text: str, style: kakaowork.blockkit.ButtonStyle = ButtonStyle.DEFAULT, action_type: kakaowork.blockkit.ButtonActionType = None, action_name: str = None, value: str = None)

Bases: kakaowork.blockkit.Block

action_name: Optional[str]
action_type: Optional[kakaowork.blockkit.ButtonActionType]
style: kakaowork.blockkit.ButtonStyle
text: str
value: Optional[str]
class kakaowork.blockkit.ButtonStyle(value)

Bases: kakaowork.consts.StrEnum

An enumeration.

DANGER = 'danger'
DEFAULT = 'default'
PRIMARY = 'primary'
class kakaowork.blockkit.ContextBlock(*, type: kakaowork.blockkit.BlockType, content: kakaowork.blockkit.TextBlock, image: kakaowork.blockkit.ImageLinkBlock)

Bases: kakaowork.blockkit.Block

content: kakaowork.blockkit.TextBlock
image: kakaowork.blockkit.ImageLinkBlock
class kakaowork.blockkit.DescriptionBlock(*, type: kakaowork.blockkit.BlockType, term: str, content: kakaowork.blockkit.TextBlock, accent: bool = None)

Bases: kakaowork.blockkit.Block

accent: Optional[bool]
content: kakaowork.blockkit.TextBlock
term: str
class kakaowork.blockkit.DividerBlock(*, type: kakaowork.blockkit.BlockType)

Bases: kakaowork.blockkit.Block

type: kakaowork.blockkit.BlockType
class kakaowork.blockkit.HeaderBlock(*, type: kakaowork.blockkit.BlockType, text: str, style: kakaowork.blockkit.HeaderStyle = HeaderStyle.BLUE)

Bases: kakaowork.blockkit.Block

style: kakaowork.blockkit.HeaderStyle
text: str
class kakaowork.blockkit.HeaderStyle(value)

Bases: kakaowork.consts.StrEnum

An enumeration.

BLUE = 'blue'
RED = 'red'
YELLOW = 'yellow'
class kakaowork.blockkit.ImageLinkBlock(*, type: kakaowork.blockkit.BlockType, url: pydantic.networks.AnyHttpUrl)

Bases: kakaowork.blockkit.Block

url: pydantic.networks.AnyHttpUrl
class kakaowork.blockkit.InputBlock(*, type: kakaowork.blockkit.BlockType, name: str, required: bool = None, placeholder: str = None)

Bases: kakaowork.blockkit.Block

name: str
placeholder: Optional[str]
required: Optional[bool]
class kakaowork.blockkit.LabelBlock(*, type: kakaowork.blockkit.BlockType, text: str, markdown: bool)

Bases: kakaowork.blockkit.Block

markdown: bool
text: str
class kakaowork.blockkit.SectionBlock(*, type: kakaowork.blockkit.BlockType, content: kakaowork.blockkit.TextBlock, accessory: kakaowork.blockkit.ImageLinkBlock)

Bases: kakaowork.blockkit.Block

accessory: kakaowork.blockkit.ImageLinkBlock
content: kakaowork.blockkit.TextBlock
class kakaowork.blockkit.SelectBlock(*, type: kakaowork.blockkit.BlockType, name: str, options: List[kakaowork.blockkit.SelectBlockOption], required: bool = None, placeholder: str = None)

Bases: kakaowork.blockkit.Block

name: str
options: List[kakaowork.blockkit.SelectBlockOption]
placeholder: Optional[str]
required: Optional[bool]
class kakaowork.blockkit.SelectBlockOption(*, text: str, value: str)

Bases: pydantic.main.BaseModel

text: str
value: str
class kakaowork.blockkit.TextBlock(*, type: kakaowork.blockkit.BlockType, text: str, markdown: bool = None, inlines: List[kakaowork.blockkit.TextInline] = None)

Bases: kakaowork.blockkit.Block

inlines: Optional[List[kakaowork.blockkit.TextInline]]
markdown: Optional[bool]
text: str
class kakaowork.blockkit.TextInline(*, type: kakaowork.blockkit.TextInlineType, text: str, bold: bool = None, italic: bool = None, strike: bool = None, color: kakaowork.blockkit.TextInlineColor = None, url: str = None)

Bases: pydantic.main.BaseModel

class Config

Bases: object

underscore_attrs_are_private = True
validate_assignment = True
bold: Optional[bool]
color: Optional[kakaowork.blockkit.TextInlineColor]
italic: Optional[bool]
strike: Optional[bool]
text: str
type: kakaowork.blockkit.TextInlineType
url: Optional[str]
class kakaowork.blockkit.TextInlineColor(value)

Bases: kakaowork.consts.StrEnum

An enumeration.

BLUE = 'blue'
DEFAULT = 'default'
GREY = 'grey'
RED = 'red'
class kakaowork.blockkit.TextInlineType(value)

Bases: kakaowork.consts.StrEnum

An enumeration.

STYLED = 'styled'