wxc_sdk.attachment_actions package¶
Attachment actions API
- class wxc_sdk.attachment_actions.AttachmentActionsApi(*, session: RestSession, base: str | None = None)[source]¶
Bases:
ApiChild
Users create attachment actions by interacting with message attachments such as clicking on a submit button in a card.
- details(action_id: str) AttachmentAction [source]¶
Shows details for a attachment action, by ID. Specify the attachment action ID in the id URI parameter.
- Parameters:
action_id (str) – A unique identifier for the attachment action.
- base = 'attachment/actions'¶
- session: RestSession¶
REST session
- class wxc_sdk.attachment_actions.AttachmentAction(*, id: str | None = None, personId: str | None = None, roomId: str | None = None, type: Literal['submit'], messageId: str | None = None, inputs: dict, created: datetime | None = None)[source]¶
Bases:
ApiModel
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
- id: str | None¶
A unique identifier for the action.
- person_id: str | None¶
The ID of the person who performed the action.
- room_id: str | None¶
The ID of the room in which the action was performed.
- type: Literal['submit']¶
the type of action performed.
- message_id: str | None¶
The ID of the message which contains the attachment.
- inputs: dict¶
The attachment action’s inputs.
- created: datetime | None¶
The date and time the action was created.
- class wxc_sdk.attachment_actions.AttachmentActionData(*, id: str, type: Literal['submit'], messageId: str, personId: str, roomId: str, created: datetime, **extra_data: Any)[source]¶
Bases:
WebhookEventData
Data in a webhook “attachmentActions” event
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
- resource: ClassVar = 'attachmentActions'¶
- id: str¶
- type: Literal['submit']¶
- message_id: str¶
- person_id: str¶
- room_id: str¶
- created: datetime¶