ProjectplaceClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'set_webhook_card_create': {'operation_id': 'set_webhook_card_create', 'path': '/{connectionId}/v1/external_notifications/0/hooks/set_power_hook', 'method': 'post', 'required_parameters': [], 'callback_payload_type': None}, 'set_webhook_properties_change': {'operation_id': 'set_webhook_properties_change', 'path': '/{connectionId}/v1/external_notifications/1/hooks/set_power_hook', 'method': 'post', 'required_parameters': [], 'callback_payload_type': None}, 'set_webhook_card_due_date': {'operation_id': 'set_webhook_card_due_date', 'path': '/{connectionId}/v1/external_notifications/2/hooks/set_power_hook', 'method': 'post', 'required_parameters': [], 'callback_payload_type': None}}

Classes

SetWebhookCardCreateInput dataclass

SetWebhookCardCreateInput(card_create: Optional[bool] = None, webhook: Optional[str] = None, board_id: Optional[int] = None)

When a card is created

Attributes

card_create class-attribute instance-attribute

card_create: Optional[bool] = None

Triggers when a card is created on the defined board

webhook class-attribute instance-attribute

webhook: Optional[str] = None

webhook

board_id class-attribute instance-attribute

board_id: Optional[int] = None

The id of the Board that the card belongs to

SetWebhookPropertiesChangeInput dataclass

SetWebhookPropertiesChangeInput(card_blocked: Optional[bool] = None, card_unblock: Optional[bool] = None, status_change: Optional[bool] = None, card_done: Optional[bool] = None, description_changed: Optional[bool] = None, due_date_changed: Optional[bool] = None, webhook: Optional[str] = None, board_id: Optional[int] = None)

When a card's properties are changed

Attributes

card_blocked class-attribute instance-attribute

card_blocked: Optional[bool] = None

Triggers when a card is blocked

card_unblock class-attribute instance-attribute

card_unblock: Optional[bool] = None

Triggers when a card block is removed

status_change class-attribute instance-attribute

status_change: Optional[bool] = None

Triggers when a card is moved to another column on the

card_done class-attribute instance-attribute

card_done: Optional[bool] = None

Triggers when a card is set to done by moving it to the rightmost column on the board

description_changed class-attribute instance-attribute

description_changed: Optional[bool] = None

Triggers when the description of a card changes

due_date_changed class-attribute instance-attribute

due_date_changed: Optional[bool] = None

Triggers when the due date of a card changes

webhook class-attribute instance-attribute

webhook: Optional[str] = None

webhook

board_id class-attribute instance-attribute

board_id: Optional[int] = None

The id of the Board that the card belongs to

SetWebhookCardDueDateInput dataclass

SetWebhookCardDueDateInput(due_today: Optional[bool] = None, webhook: Optional[str] = None, board_id: Optional[int] = None)

When a card is due

Attributes

due_today class-attribute instance-attribute

due_today: Optional[bool] = None

Triggers on the date that the card is due

webhook class-attribute instance-attribute

webhook: Optional[str] = None

webhook

board_id class-attribute instance-attribute

board_id: Optional[int] = None

The id of the Board that the card belongs to

CreateCardInput dataclass

CreateCardInput(column_id: Optional[int] = None, title: Optional[str] = None, description: Optional[str] = None, assignee_email: Optional[str] = None, planlet_id: Optional[int] = None, due_date: Optional[str] = None, label_id: Optional[int] = None)

Create Card

Attributes

column_id class-attribute instance-attribute

column_id: Optional[int] = None

The column where the card should be created

title class-attribute instance-attribute

title: Optional[str] = None

The title of the created card

description class-attribute instance-attribute

description: Optional[str] = None

The description of the created card

assignee_email class-attribute instance-attribute

assignee_email: Optional[str] = None

The person that will be assigned to the created card

planlet_id class-attribute instance-attribute

planlet_id: Optional[int] = None

The activity the Card should be associated with

due_date class-attribute instance-attribute

due_date: Optional[str] = None

The due date of the created card

label_id class-attribute instance-attribute

label_id: Optional[int] = None

The label of the created card

CreateCardResponse dataclass

CreateCardResponse(access: Optional[str] = None, assignee: Optional[Dict[str, Any]] = None, assignee_id: Optional[int] = None, board_id: Optional[int] = None, board_name: Optional[str] = None, direct_url: Optional[str] = None, due_date: Optional[str] = None, estimated_time: Optional[str] = None, id: Optional[int] = None, is_blocked: Optional[bool] = None, is_blocked_reason: Optional[str] = None, is_done: Optional[bool] = None, is_template: Optional[bool] = None, label_id: Optional[int] = None, planlet_id: Optional[int] = None, reported_time: Optional[str] = None, title: Optional[str] = None)

Response for Create Card

Attributes

access class-attribute instance-attribute

access: Optional[str] = None

Access rights

assignee class-attribute instance-attribute

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

The person who is assigned to the card

assignee_id class-attribute instance-attribute

assignee_id: Optional[int] = None

The id of the person who is assigned the card

board_id class-attribute instance-attribute

board_id: Optional[int] = None

The ID of the board

board_name class-attribute instance-attribute

board_name: Optional[str] = None

The name of the board

direct_url class-attribute instance-attribute

direct_url: Optional[str] = None

The card's direct URL

due_date class-attribute instance-attribute

due_date: Optional[str] = None

The due date of the card

estimated_time class-attribute instance-attribute

estimated_time: Optional[str] = None

Estimated time for completion

id class-attribute instance-attribute

id: Optional[int] = None

The ID of the card

is_blocked class-attribute instance-attribute

is_blocked: Optional[bool] = None

Is the card is

is_blocked_reason class-attribute instance-attribute

is_blocked_reason: Optional[str] = None

The blocking reason - if blocked

is_done class-attribute instance-attribute

is_done: Optional[bool] = None

Is the card done

is_template class-attribute instance-attribute

is_template: Optional[bool] = None

Is a template card

label_id class-attribute instance-attribute

label_id: Optional[int] = None

The id of the label

planlet_id class-attribute instance-attribute

planlet_id: Optional[int] = None

The id of the activity

reported_time class-attribute instance-attribute

reported_time: Optional[str] = None

How much time was reported for the card

title class-attribute instance-attribute

title: Optional[str] = None

The card's title

MoveCardInput dataclass

MoveCardInput(card_id: Optional[int] = None, card_title: Optional[str] = None, column_id: Optional[int] = None)

Move card to another column

Attributes

card_id class-attribute instance-attribute

card_id: Optional[int] = None

The card to be moved

card_title class-attribute instance-attribute

card_title: Optional[str] = None

The title of the card to be moved

column_id class-attribute instance-attribute

column_id: Optional[int] = None

The column where the card should be moved to

MoveCardResponse dataclass

MoveCardResponse(access: Optional[str] = None, assignee_id: Optional[int] = None, board_id: Optional[int] = None, board_name: Optional[str] = None, column_id: Optional[int] = None, column_name: Optional[str] = None, description: Optional[str] = None, direct_url: Optional[str] = None, due_date: Optional[str] = None, estimated_time: Optional[str] = None, id: Optional[int] = None, is_blocked: Optional[bool] = None, is_blocked_reason: Optional[str] = None, is_done: Optional[bool] = None, is_template: Optional[bool] = None, label_id: Optional[int] = None, label_name: Optional[str] = None, planlet_id: Optional[int] = None, reported_time: Optional[str] = None, title: Optional[str] = None)

Response for Move card to another column

Attributes

access class-attribute instance-attribute

access: Optional[str] = None

Access rights

assignee_id class-attribute instance-attribute

assignee_id: Optional[int] = None

The ID of the person the card assigned to

board_id class-attribute instance-attribute

board_id: Optional[int] = None

The ID of the board

board_name class-attribute instance-attribute

board_name: Optional[str] = None

The name of the board

column_id class-attribute instance-attribute

column_id: Optional[int] = None

The id of the column the card is on

column_name class-attribute instance-attribute

column_name: Optional[str] = None

The name of the column

description class-attribute instance-attribute

description: Optional[str] = None

The description on the card

direct_url class-attribute instance-attribute

direct_url: Optional[str] = None

The direct URL of the card

due_date class-attribute instance-attribute

due_date: Optional[str] = None

The due date of the card

estimated_time class-attribute instance-attribute

estimated_time: Optional[str] = None

The estimated time of the card

id class-attribute instance-attribute

id: Optional[int] = None

The id of the card

is_blocked class-attribute instance-attribute

is_blocked: Optional[bool] = None

Is the card blocked

is_blocked_reason class-attribute instance-attribute

is_blocked_reason: Optional[str] = None

The reason the card is blocked

is_done class-attribute instance-attribute

is_done: Optional[bool] = None

Is the card done

is_template class-attribute instance-attribute

is_template: Optional[bool] = None

Is a template card

label_id class-attribute instance-attribute

label_id: Optional[int] = None

The id of the card's label

label_name class-attribute instance-attribute

label_name: Optional[str] = None

The name of the label

planlet_id class-attribute instance-attribute

planlet_id: Optional[int] = None

The id of the activity

reported_time class-attribute instance-attribute

reported_time: Optional[str] = None

The time reported for this card

title class-attribute instance-attribute

title: Optional[str] = None

The title of the card

ProjectplaceClient

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

Bases: ConnectorClientBase

Typed client for projectplace connector.

Initialize a ProjectplaceClient.

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_card_async async

create_card_async(input: CreateCardInput, board_id: int) -> dict[str, Any] | None

Create Card

Creates a new card with the parameters provided

move_card_async async

move_card_async(input: MoveCardInput, board_id: int) -> dict[str, Any] | None

Move card to another column

Move a card on the selected board

list_boards_async async

list_boards_async() -> dict[str, Any] | None

Lists the boards the user have access to

Lists the boards that are part of the projects the user have access to