WaywedoClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'Checklist_Create_WebHook': {'operation_id': 'Checklist_Create_WebHook', 'path': '/{connectionId}/v1/Webhook/events/checklist_start', 'method': 'post', 'required_parameters': ['Webhook Registration'], 'callback_payload_type': 'WebhookRegistered'}, 'New_Comment_WebHook': {'operation_id': 'New_Comment_WebHook', 'path': '/{connectionId}/v1/Webhook/events/new_comment', 'method': 'post', 'required_parameters': ['Webhook Registration'], 'callback_payload_type': 'WebhookRegistered'}, 'Finish_Checklist_WebHook': {'operation_id': 'Finish_Checklist_WebHook', 'path': '/{connectionId}/v1/Webhook/events/checklist_finish', 'method': 'post', 'required_parameters': ['Webhook Registration'], 'callback_payload_type': 'WebhookRegistered'}, 'Invite_Supervisor_WebHook': {'operation_id': 'Invite_Supervisor_WebHook', 'path': '/{connectionId}/v1/Webhook/events/supervisor_invite', 'method': 'post', 'required_parameters': ['Webhook Registration'], 'callback_payload_type': 'WebhookRegistered'}, 'Generate_Acceptance_PDF_WebHook': {'operation_id': 'Generate_Acceptance_PDF_WebHook', 'path': '/{connectionId}/v1/Webhook/events/generate_acceptance_pdf', 'method': 'post', 'required_parameters': ['Webhook Registration'], 'callback_payload_type': 'WebhookRegistered'}, 'Checklist_Step_Completed_WebHook': {'operation_id': 'Checklist_Step_Completed_WebHook', 'path': '/{connectionId}/v1/Webhook/events/checklist_step_completed', 'method': 'post', 'required_parameters': ['Webhook Registration'], 'callback_payload_type': 'WebhookRegistered'}}

Classes

CommentAddInput dataclass

CommentAddInput(instance_id: Optional[str] = None, step_id: Optional[str] = None, user_id: Optional[int] = None, message: Optional[str] = None, bot: Optional[str] = None)

Add a comment to a checklist instance step

Attributes

instance_id class-attribute instance-attribute

instance_id: Optional[str] = field(default=None, metadata={'wire_name': 'instanceId'})

Select the checklist instance

step_id class-attribute instance-attribute

step_id: Optional[str] = field(default=None, metadata={'wire_name': 'stepId'})

Select the step of the checklist instance

user_id class-attribute instance-attribute

user_id: Optional[int] = field(default=None, metadata={'wire_name': 'userId'})

Select the user creating the comment

message class-attribute instance-attribute

message: Optional[str] = None

Specify the comment to add

bot class-attribute instance-attribute

bot: Optional[str] = None

The name of the bot creating the comment

ChecklistComment dataclass

ChecklistComment(id: Optional[str] = None, type_: Optional[int] = None, procedure_id: Optional[int] = None, procedure_title: Optional[str] = None, instance_id: Optional[str] = None, step_id: Optional[str] = None, instance_title: Optional[str] = None, comment: Optional[str] = None, created: Optional[str] = None, created_by: Optional[str] = None, image_url: Optional[str] = None)

Response for Add a comment to a checklist instance step

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the comment.

type_ class-attribute instance-attribute

type_: Optional[int] = field(default=None, metadata={'wire_name': 'type'})

The type of comment; either 1 (standard) or 2 (attachment).

procedure_id class-attribute instance-attribute

procedure_id: Optional[int] = field(default=None, metadata={'wire_name': 'procedureId'})

The unique ID of the procedure.

procedure_title class-attribute instance-attribute

procedure_title: Optional[str] = field(default=None, metadata={'wire_name': 'procedureTitle'})

The title of the procedure.

instance_id class-attribute instance-attribute

instance_id: Optional[str] = field(default=None, metadata={'wire_name': 'instanceId'})

The unique ID of the checklist instance.

step_id class-attribute instance-attribute

step_id: Optional[str] = field(default=None, metadata={'wire_name': 'stepId'})

The unique ID of the checklist step.

instance_title class-attribute instance-attribute

instance_title: Optional[str] = field(default=None, metadata={'wire_name': 'instanceTitle'})

The title of the checklist instance.

comment class-attribute instance-attribute

comment: Optional[str] = None

The comment text added to the step.

created class-attribute instance-attribute

created: Optional[str] = None

The date and time the comment was created.

created_by class-attribute instance-attribute

created_by: Optional[str] = field(default=None, metadata={'wire_name': 'createdBy'})

The email address of the user who created the comment.

image_url class-attribute instance-attribute

image_url: Optional[str] = field(default=None, metadata={'wire_name': 'imageUrl'})

The URL to the attached file. Valid for 5 minutes.

ChecklistInstancesInput dataclass

ChecklistInstancesInput(procedure_id: Optional[int] = None, title: Optional[str] = None, user_id: Optional[int] = None, company_role_id: Optional[int] = None, bot: Optional[str] = None)

Create Checklist Instance

Attributes

procedure_id class-attribute instance-attribute

procedure_id: Optional[int] = field(default=None, metadata={'wire_name': 'procedureId'})

Select a checklist master

title class-attribute instance-attribute

title: Optional[str] = None

The title of the checklist instance

user_id class-attribute instance-attribute

user_id: Optional[int] = field(default=None, metadata={'wire_name': 'userId'})

Select the user to add as a collaborator

company_role_id class-attribute instance-attribute

company_role_id: Optional[int] = field(default=None, metadata={'wire_name': 'companyRoleId'})

Select the company role to add as a collaborator.

bot class-attribute instance-attribute

bot: Optional[str] = None

The name of the bot creating the instance

ChecklistInstance dataclass

ChecklistInstance(id: Optional[str] = None, procedure_id: Optional[int] = None, title: Optional[str] = None, url: Optional[str] = None, created: Optional[str] = None, created_by: Optional[str] = None, finished: Optional[str] = None, earliest_due: Optional[str] = None, latest_due: Optional[str] = None)

Response for Create Checklist Instance

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the checklist instance.

procedure_id class-attribute instance-attribute

procedure_id: Optional[int] = field(default=None, metadata={'wire_name': 'procedureId'})

The unique ID of the procedure.

title class-attribute instance-attribute

title: Optional[str] = None

The title of the checklist instance.

url class-attribute instance-attribute

url: Optional[str] = None

The URL to the checklist instance.

created class-attribute instance-attribute

created: Optional[str] = None

The date and time the checklist instance was started.

created_by class-attribute instance-attribute

created_by: Optional[str] = field(default=None, metadata={'wire_name': 'createdBy'})

The email address of the user who started the checklist instance.

finished class-attribute instance-attribute

finished: Optional[str] = None

The date and time the checklist instance was finished.

earliest_due class-attribute instance-attribute

earliest_due: Optional[str] = field(default=None, metadata={'wire_name': 'earliestDue'})

The earliest date and time the checklist instance could be due.

latest_due class-attribute instance-attribute

latest_due: Optional[str] = field(default=None, metadata={'wire_name': 'latestDue'})

The latest date and time the checklist instance could be due.

ChecklistStep dataclass

ChecklistStep(id: Optional[str] = None, title: Optional[str] = None, ordinal: Optional[int] = None)

Response for Find Checklist Step

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the instance step.

title class-attribute instance-attribute

title: Optional[str] = None

The title of the instance step.

ordinal class-attribute instance-attribute

ordinal: Optional[int] = None

The number of the instance step.

ChecklistStepsCompleteInput dataclass

ChecklistStepsCompleteInput(user_id: Optional[int] = None, bot: Optional[str] = None)

Complete a Checklist Step

Attributes

user_id class-attribute instance-attribute

user_id: Optional[int] = field(default=None, metadata={'wire_name': 'userId'})

Select the user completing the step

bot class-attribute instance-attribute

bot: Optional[str] = None

The name of the bot that completed the checklist step

ChecklistStepsCompleteResponse dataclass

ChecklistStepsCompleteResponse(additional_properties: Dict[str, Any] = dict())

Response for Complete a Checklist Step

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CollaboratorsAddInput dataclass

CollaboratorsAddInput(checklist_instance_id: Optional[str] = None, user_ids: Optional[List[int]] = None, company_role_ids: Optional[List[int]] = None)

Add Collaborators to a Checklist Instance

Attributes

checklist_instance_id class-attribute instance-attribute

checklist_instance_id: Optional[str] = field(default=None, metadata={'wire_name': 'checklistInstanceId'})

Select the checklist instance

CollaboratorsAddResponse dataclass

CollaboratorsAddResponse(additional_properties: Dict[str, Any] = dict())

Response for Add Collaborators to a Checklist Instance

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

Procedure dataclass

Procedure(id: Optional[int] = None, title: Optional[str] = None, status: Optional[str] = None, summary: Optional[str] = None, created_by: Optional[str] = None, url: Optional[str] = None, restricted: Optional[bool] = None, type_: Optional[int] = None)

Response for Find Checklist

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

The unique ID of the procedure.

title class-attribute instance-attribute

title: Optional[str] = None

The title of the procedure.

status class-attribute instance-attribute

status: Optional[str] = None

The publishing status of the procedure.

summary class-attribute instance-attribute

summary: Optional[str] = None

The summary of the procedure.

created_by class-attribute instance-attribute

created_by: Optional[str] = field(default=None, metadata={'wire_name': 'createdBy'})

The email of the user that created the procedure.

url class-attribute instance-attribute

url: Optional[str] = None

The URL of the procedure.

restricted class-attribute instance-attribute

restricted: Optional[bool] = None

Whether the procedure is restricted or not.

type_ class-attribute instance-attribute

type_: Optional[int] = field(default=None, metadata={'wire_name': 'type'})

The type of procedure; 1 (standard) or 2 (checklist)

User dataclass

User(id: Optional[int] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, email: Optional[str] = None)

Response for Find User

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

The unique ID of the user.

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

The first name of the user.

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

The last name of the user.

email class-attribute instance-attribute

email: Optional[str] = None

The email address of the user.

UsersInput dataclass

UsersInput(first_name: Optional[str] = None, last_name: Optional[str] = None, email: Optional[str] = None, security_role: Optional[int] = None, company_roles: Optional[List[int]] = None, time_zone_id: Optional[str] = None)

Add a New User

Attributes

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

The first name of the user.

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

The last name of the user.

email class-attribute instance-attribute

email: Optional[str] = None

The email address of the user.

security_role class-attribute instance-attribute

security_role: Optional[int] = field(default=None, metadata={'wire_name': 'securityRole'})

Select a security role.

time_zone_id class-attribute instance-attribute

time_zone_id: Optional[str] = field(default=None, metadata={'wire_name': 'timeZoneId'})

Select the user's timezone.

UsersPostResponse dataclass

UsersPostResponse(additional_properties: Dict[str, Any] = dict())

Response for Add a New User

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

ChecklistCreateWebHookInput dataclass

ChecklistCreateWebHookInput(callback_url: Optional[str] = None)

When a checklist instance is started

Attributes

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

The URL to call when action occurs.

WebhookRegistered dataclass

WebhookRegistered(id: Optional[int] = None, callbackurl: Optional[str] = None, created: Optional[str] = None, web_hook_event: Optional[str] = None)

Response for When a checklist instance is started

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

The unique ID of the Webhook registration.

callbackurl class-attribute instance-attribute

callbackurl: Optional[str] = None

The URL to call when action occurs.

created class-attribute instance-attribute

created: Optional[str] = None

The date and time the webhook was registered.

web_hook_event class-attribute instance-attribute

web_hook_event: Optional[str] = field(default=None, metadata={'wire_name': 'webHookEvent'})

The name of the webhook event.

NewCommentWebHookInput dataclass

NewCommentWebHookInput(callback_url: Optional[str] = None)

When a comment is added to a checklist

Attributes

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

The URL to call when action occurs.

FinishChecklistWebHookInput dataclass

FinishChecklistWebHookInput(callback_url: Optional[str] = None)

When a checklist is finished

Attributes

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

The URL to call when action occurs.

InviteSupervisorWebHookInput dataclass

InviteSupervisorWebHookInput(callback_url: Optional[str] = None)

When a supervisor is invited

Attributes

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

The URL to call when action occurs.

GenerateAcceptancePDFWebHookInput dataclass

GenerateAcceptancePDFWebHookInput(callback_url: Optional[str] = None)

When a procedure is accepted

Attributes

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

The URL to call when action occurs.

ChecklistStepCompletedWebHookInput dataclass

ChecklistStepCompletedWebHookInput(callback_url: Optional[str] = None)

When a checklist step is completed

Attributes

callback_url class-attribute instance-attribute

callback_url: Optional[str] = field(default=None, metadata={'wire_name': 'callbackUrl'})

The URL to call when action occurs.

GetAllChecklistInstancesResponse dataclass

GetAllChecklistInstancesResponse(results: Optional[List[ChecklistInstance]] = None, total: Optional[int] = None)

Response for Get All Checklist Instances

Attributes

results class-attribute instance-attribute

results: Optional[List[ChecklistInstance]] = None

The list of checklist instances.

total class-attribute instance-attribute

total: Optional[int] = field(default=None, metadata={'wire_name': '_total'})

The total number of checklist instances.

CompletedStep dataclass

CompletedStep(id: Optional[str] = None, instance_id: Optional[str] = None, procedure_id: Optional[int] = None, created: Optional[str] = None, created_by: Optional[str] = None, due: Optional[str] = None, step: Optional[ChecklistStep] = None, decision_choices: Optional[List[str]] = None)

Definition: CompletedStep

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The unique ID of the checklist step completion.

instance_id class-attribute instance-attribute

instance_id: Optional[str] = field(default=None, metadata={'wire_name': 'instanceId'})

The unique ID of the checklist instance.

procedure_id class-attribute instance-attribute

procedure_id: Optional[int] = field(default=None, metadata={'wire_name': 'procedureId'})

The unique ID of the procedure.

created class-attribute instance-attribute

created: Optional[str] = None

The date and time the checklist step was completed.

created_by class-attribute instance-attribute

created_by: Optional[str] = field(default=None, metadata={'wire_name': 'createdBy'})

The email address of the user that completed the checklist step.

due class-attribute instance-attribute

due: Optional[str] = None

The date and time the checklist step was due.

decision_choices class-attribute instance-attribute

decision_choices: Optional[List[str]] = field(default=None, metadata={'wire_name': 'decisionChoices'})

The list of choices made if the step is a decision point.

ProcedureAcceptance dataclass

ProcedureAcceptance(id: Optional[int] = None, accepted: Optional[str] = None, created_by: Optional[str] = None, file_name: Optional[str] = None, attachment_url: Optional[str] = None, procedure_title: Optional[str] = None)

Definition: ProcedureAcceptance

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

The unique ID of the procedure acceptance

accepted class-attribute instance-attribute

accepted: Optional[str] = None

The date and time the procedure was accepted.

created_by class-attribute instance-attribute

created_by: Optional[str] = field(default=None, metadata={'wire_name': 'createdBy'})

The email address of the user that accepted the procedure.

file_name class-attribute instance-attribute

file_name: Optional[str] = field(default=None, metadata={'wire_name': 'fileName'})

The file name of the generated PDF.

attachment_url class-attribute instance-attribute

attachment_url: Optional[str] = field(default=None, metadata={'wire_name': 'attachmentUrl'})

The URL to the generated PDF. Valid for 5 minutes.

procedure_title class-attribute instance-attribute

procedure_title: Optional[str] = field(default=None, metadata={'wire_name': 'procedureTitle'})

The title of the accepted procedure.

WaywedoClient

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

Bases: ConnectorClientBase

Typed client for waywedo connector.

Initialize a WaywedoClient.

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:

comment_add_async async

comment_add_async(input: CommentAddInput) -> dict[str, Any] | None

Add a comment to a checklist instance step

Adds a new comment to an Activated Checklist Instance step.

checklist_instances_async async

checklist_instances_async(input: ChecklistInstancesInput) -> dict[str, Any] | None

Create Checklist Instance

Creates a new activated checklist instance.

checklist_instances_get_async async

checklist_instances_get_async(instance_id: str) -> dict[str, Any] | None

Get A Checklist Instance

Retrieve a specific checklist instance by ID

checklist_instances_activity_async async

checklist_instances_activity_async(instance_id: str) -> dict[str, Any] | None

Get Checklist Instance Activity

Retrieve all activity for a checklist instance

find_steps_async async

find_steps_async(instance_id: str, query: Optional[str] = None) -> dict[str, Any] | None

Find Checklist Step

Find a step of a checklist instance

checklist_steps_get_async async

checklist_steps_get_async(instance_id: str, step_id: str) -> dict[str, Any] | None

Get A Checklist Step

Retrieve a specific checklist step by ID

checklist_steps_complete_async async

checklist_steps_complete_async(input: ChecklistStepsCompleteInput, instance_id: str, step_id: str) -> dict[str, Any] | None

Complete a Checklist Step

Mark a specific step in a checklist instance as complete.

collaborators_add_async async

collaborators_add_async(input: CollaboratorsAddInput) -> dict[str, Any] | None

Add Collaborators to a Checklist Instance

Adds one or more collaborators to a checklist instance.

find_checklist_async async

find_checklist_async(query: Optional[str] = None) -> dict[str, Any] | None

Find Checklist

Search for a checklist by title

procedures_get_async async

procedures_get_async(procedure_id: int) -> dict[str, Any] | None

Get A Checklist Or Procedure

Retrieve a specific checklist or procedure by ID

find_checklist_instances_async async

find_checklist_instances_async(procedure_id: int, query: Optional[str] = None) -> dict[str, Any] | None

Find Checklist Instance

Search for a checklist instance by title.

find_user_async async

find_user_async(query: Optional[str] = None) -> dict[str, Any] | None

Find User

Search for a user by name or email.

users_async async

users_async(input: UsersInput) -> dict[str, Any] | None

Add a New User

Creates and invites a new user.

get_all_checklist_instances_async async

get_all_checklist_instances_async(limit: Optional[int] = None, offset: Optional[int] = None, status: Optional[int] = None) -> dict[str, Any] | None

Get All Checklist Instances

Retrieve a list of all activated checklist instances.