Share via

MessageTemplateItem Class

  • Reference

The message template as returned from the service.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: WhatsAppMessageTemplateItem

Readonly variables are only populated by the server, and will be ignored when sending a request.

Constructor

MessageTemplateItem(*args: Any, **kwargs: Any)

Variables

Name Description
name
str

The template's name. Required.
language
str

The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'. Required.
status
str or MessageTemplateStatus

The aggregated template status. Required. Known values are: "approved", "rejected", "pending", and "paused".
kind
str or CommunicationMessagesChannel

The type discriminator describing a template type. Required. "whatsApp"

Methods

as_dict

Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Returns

Type Description
dict

A dict JSON compatible object

clear 

clear() -> None

copy 

copy() -> Model

get 

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Required
Default value: None

items 

items() -> ItemsView[str, Any]

keys 

keys() -> KeysView[str]

pop 

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default
Required

popitem 

popitem() -> Tuple[str, Any]

setdefault 

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default
Required

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Attributes

kind

The type discriminator describing a template type. Required. "whatsApp"

kind: str

language

The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'. Required.

language: str

name

The template's name. Required.

name: str

status

"approved", "rejected", "pending", and "paused".

status: str | _models.MessageTemplateStatus