CampfireClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewRoom': {'operation_id': 'OnNewRoom', 'path': '/{connectionId}/OnNewRoom_trigger/rooms.json', 'method': 'get', 'required_parameters': ['account'], 'callback_payload_type': 'RoomsResponse'}, 'OnNewMessage': {'operation_id': 'OnNewMessage', 'path': '/{connectionId}/OnNewMessage_trigger/room/{roomId}/recent.json', 'method': 'get', 'required_parameters': ['account', 'roomId'], 'callback_payload_type': 'MessagesResponse'}, 'OnNewUpload': {'operation_id': 'OnNewUpload', 'path': '/{connectionId}/OnNewUpload_trigger/room/{roomId}/uploads.json', 'method': 'get', 'required_parameters': ['account', 'roomId'], 'callback_payload_type': 'UploadResponse'}}

Classes

CreateMessageResponse dataclass

CreateMessageResponse(message: Optional[Dict[str, Any]] = None)

Response for Create a message

Attributes

message class-attribute instance-attribute

message: Optional[Dict[str, Any]] = None

A Campfire message

RoomsResponse dataclass

RoomsResponse(rooms: Optional[List[Dict[str, Any]]] = None)

Response for When a room is created

Attributes

rooms class-attribute instance-attribute

rooms: Optional[List[Dict[str, Any]]] = None

Collection of Rooms

MessagesResponse dataclass

MessagesResponse(messages: Optional[List[Dict[str, Any]]] = None)

Response for When a new message is received

Attributes

messages class-attribute instance-attribute

messages: Optional[List[Dict[str, Any]]] = None

Collection Of messages

UploadResponse dataclass

UploadResponse(uploads: Optional[List[Dict[str, Any]]] = None)

Response for When a file is uploaded

Attributes

uploads class-attribute instance-attribute

uploads: Optional[List[Dict[str, Any]]] = None

Collection of Uploads

UserResponse dataclass

UserResponse(user: Optional[Dict[str, Any]] = None)

Response for Get user by ID

AccountsResponse dataclass

AccountsResponse(accounts: Optional[List[Dict[str, Any]]] = None)

Response for List accounts

Attributes

accounts class-attribute instance-attribute

accounts: Optional[List[Dict[str, Any]]] = None

Collection Of Accounts

Account dataclass

Account(id: Optional[int] = None, name: Optional[str] = None, app_href: Optional[str] = None, account_url: Optional[str] = None)

Definition: Account

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

Id of the account

name class-attribute instance-attribute

name: Optional[str] = None

Name of the account

app_href class-attribute instance-attribute

app_href: Optional[str] = None

Link to the account

account_url class-attribute instance-attribute

account_url: Optional[str] = None

Account Url

Room dataclass

Room(name: Optional[str] = None, id: Optional[int] = None, locked: Optional[bool] = None, topic: Optional[str] = None)

Definition: Room

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Room name.

id class-attribute instance-attribute

id: Optional[int] = None

Room Id.

locked class-attribute instance-attribute

locked: Optional[bool] = None

Boolean value, True if a room is locked.

topic class-attribute instance-attribute

topic: Optional[str] = None

Room topic or description.

Message dataclass

Message(body: Optional[str] = None, id: Optional[int] = None, starred: Optional[bool] = None)

Definition: Message

Attributes

body class-attribute instance-attribute

body: Optional[str] = None

Message Body.

id class-attribute instance-attribute

id: Optional[int] = None

Message Id.

starred class-attribute instance-attribute

starred: Optional[bool] = None

Boolean value, True if a message is starred.

Upload dataclass

Upload(full_url: Optional[str] = None, room_id: Optional[int] = None, id: Optional[int] = None, content_type: Optional[str] = None, name: Optional[str] = None, created_at: Optional[str] = None)

Definition: Upload

Attributes

full_url class-attribute instance-attribute

full_url: Optional[str] = None

File Url.

room_id class-attribute instance-attribute

room_id: Optional[int] = None

Room Id.

id class-attribute instance-attribute

id: Optional[int] = None

File Id.

content_type class-attribute instance-attribute

content_type: Optional[str] = None

Format of the uploaded file.

name class-attribute instance-attribute

name: Optional[str] = None

File name.

created_at class-attribute instance-attribute

created_at: Optional[str] = None

Timestamp of upload.

CreateUploadResponse dataclass

CreateUploadResponse(upload: Optional[Upload] = None)

Definition: CreateUploadResponse

CampfireClient

CampfireClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for campfire connector.

Initialize a CampfireClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

create_message_async async

create_message_async(room_id: str, account: str, message: str) -> dict[str, Any] | None

Create a message

Sends a message to the given room.

get_user_async async

get_user_async(user_id: int, account: str) -> dict[str, Any] | None

Get user by ID

Retrieves information about a user by given ID

list_accounts_async async

list_accounts_async(parent_operation: Optional[str] = None) -> dict[str, Any] | None

List accounts

Retrieves the list of accounts this user has access too

list_rooms_async async

list_rooms_async(account: str) -> dict[str, Any] | None

List Rooms

Retrieves the list of rooms in an account