Module intercom_python_sdk.canvas.components

Classes

class ActionParameters (type: ActionType = ActionType.SUBMIT, url: Optional[str] = None)

This class is used to configure an action component. It has three types: submit, url, and sheet.

References: https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/submit-action/#parameters https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/url-action/#parameters https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/sheets-action/

Expand source code

@dataclass
class ActionParameters:
    """
    This class is used to configure an action component. It has three types: submit, url, and sheet.

    References:
    https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/submit-action/#parameters
    https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/url-action/#parameters
    https://developers.intercom.com/docs/references/canvas-kit/actioncomponents/sheets-action/
    """

    type: ActionType = ActionType.SUBMIT
    url: Optional[str] = None

Class variables

var type : ActionType

var url : Optional[str]

class ActionType (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class ActionType(Enum):
    SUBMIT = "submit"
    URL = "url"
    SHEET = "sheet"

Ancestors

• enum.Enum

Class variables

var SHEET

var SUBMIT

var URL

class ButtonParameters (id: str, label: str = 'label', disabled: bool = False, style: ButtonStyle = ButtonStyle.PRIMARY, action: ActionParameters = <factory>)

This class is used to configure a button component.

References: https://developers.intercom.com/docs/references/canvas-kit/interactivecomponents/button/#parameters

Expand source code

@dataclass
class ButtonParameters:
    """
    This class is used to configure a button component.

    References:
    https://developers.intercom.com/docs/references/canvas-kit/interactivecomponents/button/#parameters
    """

    id: str
    label: str = "label"
    disabled: bool = False
    style: ButtonStyle = ButtonStyle.PRIMARY
    action: ActionParameters = field(default_factory=lambda: ActionParameters())

Class variables

var action : ActionParameters

var disabled : bool

var id : str

var label : str

var style : ButtonStyle

class ButtonStyle (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class ButtonStyle(Enum):
    PRIMARY = "primary"
    SECONDARY = "secondary"
    LINK = "link"

Ancestors

• enum.Enum

Class variables

var LINK

var PRIMARY

var SECONDARY

class DropdownParameters (id: str, options: List[OptionParameters], label: str = 'label', value: Optional[str] = None, disabled: bool = False)

This class is used to configure a dropdown component.

References: https://developers.intercom.com/docs/references/canvas-kit/interactivecomponents/dropdown/#dropdown-parameters

Expand source code

@dataclass
class DropdownParameters:
    """
    This class is used to configure a dropdown component.

    References:
    https://developers.intercom.com/docs/references/canvas-kit/interactivecomponents/dropdown/#dropdown-parameters
    """

    id: str
    options: List[OptionParameters]
    label: str = "label"
    value: Optional[str] = None
    disabled: bool = False

Class variables

var disabled : bool

var id : str

var label : str

var options : List[OptionParameters]

var value : Optional[str]

class InputParameters (id: str, label: str = 'label', placeholder: Optional[str] = None, value: Optional[str] = None, disabled: bool = False)

This class is used to configure an input component.

References: https://developers.intercom.com/docs/references/canvas-kit/interactivecomponents/input/#parameters

Expand source code

@dataclass
class InputParameters:
    """
    This class is used to configure an input component.

    References:
    https://developers.intercom.com/docs/references/canvas-kit/interactivecomponents/input/#parameters
    """

    id: str
    label: str = "label"
    placeholder: Optional[str] = None
    value: Optional[str] = None
    disabled: bool = False

Class variables

var disabled : bool

var id : str

var label : str

var placeholder : Optional[str]

var value : Optional[str]

class OptionParameters (id: Optional[str], text: str = 'text', disabled: bool = False)

This class is used to configure an option component.

References: https://developers.intercom.com/docs/references/canvas-kit/interactivecomponents/dropdown/#dropdown-parameters

Expand source code

@dataclass
class OptionParameters:
    """
    This class is used to configure an option component.

    References:
    https://developers.intercom.com/docs/references/canvas-kit/interactivecomponents/dropdown/#dropdown-parameters
    """

    id: Optional[str]
    text: str = "text"
    disabled: bool = False

Class variables

var disabled : bool

var id : Optional[str]

var text : str

class SpacerParameters (id: Optional[str] = None, size: SpacerSize = SpacerSize.MEDIUM)

SpacerParameters(id: Optional[str] = None, size: intercom_python_sdk.canvas.components.SpacerSize = )

Expand source code

@dataclass
class SpacerParameters:
    id: Optional[str] = None
    size: SpacerSize = SpacerSize.MEDIUM

Class variables

var id : Optional[str]

var size : SpacerSize

class SpacerSize (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class SpacerSize(Enum):
    EXTRA_SMALL = "xs"
    SMALL = "s"
    MEDIUM = "m"
    LARGE = "l"
    EXTRA_LARGE = "xl"

Ancestors

• enum.Enum

Class variables

var EXTRA_LARGE

var EXTRA_SMALL

var LARGE

var MEDIUM

var SMALL

class TextAlign (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class TextAlign(Enum):
    LEFT = "left"
    CENTER = "center"
    RIGHT = "right"

Ancestors

• enum.Enum

Class variables

var CENTER

var LEFT

var RIGHT

class TextParameters (id: Optional[str] = None, text: str = 'text', style: TextStyle = TextStyle.PARAGRAPH, align: TextAlign = TextAlign.LEFT)

This class is used to configure a text component.

References: https://developers.intercom.com/docs/references/canvas-kit/presentationcomponents/text/#parameters

Expand source code

@dataclass
class TextParameters:
    """
    This class is used to configure a text component.

    References:
    https://developers.intercom.com/docs/references/canvas-kit/presentationcomponents/text/#parameters
    """

    id: Optional[str] = None
    text: str = "text"
    style: TextStyle = TextStyle.PARAGRAPH
    align: TextAlign = TextAlign.LEFT

Class variables

var align : TextAlign

var id : Optional[str]

var style : TextStyle

var text : str

class TextStyle (value, names=None, *, module=None, qualname=None, type=None, start=1)

An enumeration.

Expand source code

class TextStyle(Enum):
    HEADER = "header"
    MUTED = "muted"
    PARAGRAPH = "paragraph"
    ERROR = "error"

Ancestors

• enum.Enum

Class variables

var ERROR

var HEADER

var MUTED

var PARAGRAPH