canvas 0.32.0__py3-none-any.whl → 0.33.1__py3-none-any.whl

canvas_sdk/commands/commands/questionnaire/question.py

@@ -132,3 +132,13 @@ class CheckboxQuestion(BaseQuestion):
         self.response.append(
             {"text": option.name, "value": option.dbid, "comment": comment, "selected": selected}
         )
+
+
+__exports__ = (
+    "ResponseOption",
+    "BaseQuestion",
+    "TextQuestion",
+    "IntegerQuestion",
+    "RadioQuestion",
+    "CheckboxQuestion",
+)

canvas_sdk/commands/commands/reason_for_visit.py

@@ -47,3 +47,6 @@ class ReasonForVisitCommand(_BaseCommand):
         # the commands api does not include the 'structured' field in the fields response
         command_schema.pop("structured")
         return command_schema
+
+
+__exports__ = ("ReasonForVisitCommand",)

canvas_sdk/commands/commands/refer.py

@@ -48,3 +48,6 @@ class ReferCommand(BaseCommand):
             values["service_provider"] = self.service_provider.__dict__
 
         return values
+
+
+__exports__ = ("ReferCommand",)

canvas_sdk/commands/commands/refill.py

@@ -43,3 +43,6 @@ class RefillCommand(PrescribeCommand):
                 )
 
         return errors
+
+
+__exports__ = ("RefillCommand",)

canvas_sdk/commands/commands/remove_allergy.py

@@ -16,3 +16,6 @@ class RemoveAllergyCommand(BaseCommand):
         json_schema_extra={"commands_api_name": "allergy"},
     )
     narrative: str | None = None
+
+
+__exports__ = ("RemoveAllergyCommand",)

canvas_sdk/commands/commands/resolve_condition.py

@@ -41,3 +41,6 @@ class ResolveConditionCommand(BaseCommand):
                 )
 
         return errors
+
+
+__exports__ = ("ResolveConditionCommand",)

canvas_sdk/commands/commands/review_of_systems.py

@@ -7,3 +7,6 @@ class ReviewOfSystemsCommand(QuestionnaireCommand):
     class Meta:
         key = "ros"
         commit_required_fields = ("questionnaire_id",)
+
+
+__exports__ = ("ReviewOfSystemsCommand",)

canvas_sdk/commands/commands/stop_medication.py

@@ -15,3 +15,6 @@ class StopMedicationCommand(_BaseCommand):
         default=None, json_schema_extra={"commands_api_name": "medication"}
     )
     rationale: str | None = None
+
+
+__exports__ = ("StopMedicationCommand",)

canvas_sdk/commands/commands/structured_assessment.py

@@ -7,3 +7,6 @@ class StructuredAssessmentCommand(QuestionnaireCommand):
     class Meta:
         key = "structuredAssessment"
         commit_required_fields = ("questionnaire_id",)
+
+
+__exports__ = ("StructuredAssessmentCommand",)

canvas_sdk/commands/commands/task.py

@@ -39,3 +39,10 @@ class TaskCommand(BaseCommand):
     comment: str | None = None
     labels: list[str] | None = None
     linked_items_urns: list[str] | None = None
+
+
+__exports__ = (
+    "AssigneeType",
+    "TaskAssigner",
+    "TaskCommand",
+)

canvas_sdk/commands/commands/update_diagnosis.py

@@ -15,3 +15,6 @@ class UpdateDiagnosisCommand(BaseCommand):
     new_condition_code: str | None = None
     background: str | None = None
     narrative: str | None = None
+
+
+__exports__ = ("UpdateDiagnosisCommand",)

canvas_sdk/commands/commands/update_goal.py

@@ -36,3 +36,6 @@ class UpdateGoalCommand(_BaseCommand):
     achievement_status: AchievementStatus | None = None
     priority: Priority | None = None
     progress: str | None = None
+
+
+__exports__ = ("UpdateGoalCommand",)

canvas_sdk/commands/commands/vitals.py

@@ -52,3 +52,6 @@ class VitalsCommand(BaseCommand):
     respiration_rate: conint(ge=6, le=60) | None = None  # type: ignore[valid-type]
     oxygen_saturation: conint(ge=60, le=100) | None = None  # type: ignore[valid-type]
     note: constr(max_length=150) | None = None  # type: ignore[valid-type]
+
+
+__exports__ = ("VitalsCommand",)

canvas_sdk/commands/constants.py

@@ -50,3 +50,11 @@ class ServiceProvider(Model):
     business_phone: str | None = Field(max_length=512, default=None)
     business_address: str | None = Field(max_length=512, default=None)
     notes: str | None = Field(max_length=512, default=None)
+
+
+__exports__ = (
+    "CodeSystems",
+    "Coding",
+    "ClinicalQuantity",
+    "ServiceProvider",
+)

canvas_sdk/effects/__init__.py

@@ -2,4 +2,4 @@ from canvas_generated.messages.effects_pb2 import Effect, EffectType
 
 from .base import _BaseEffect
 
-__all__ = ("Effect", "EffectType", "_BaseEffect")
+__all__ = __exports__ = ("Effect", "EffectType", "_BaseEffect")

canvas_sdk/effects/banner_alert/__init__.py

@@ -1,4 +1,4 @@
 from canvas_sdk.effects.banner_alert.add_banner_alert import AddBannerAlert
 from canvas_sdk.effects.banner_alert.remove_banner_alert import RemoveBannerAlert
 
-__all__ = ("AddBannerAlert", "RemoveBannerAlert")
+__all__ = __exports__ = ("AddBannerAlert", "RemoveBannerAlert")

canvas_sdk/effects/banner_alert/add_banner_alert.py

@@ -59,3 +59,6 @@ class AddBannerAlert(_BaseEffect):
             "key": self.key,
             "data": self.values,
         }
+
+
+__exports__ = ("AddBannerAlert",)

canvas_sdk/effects/banner_alert/remove_banner_alert.py

@@ -19,3 +19,6 @@ class RemoveBannerAlert(_BaseEffect):
     def effect_payload(self) -> dict[str, Any]:
         """The payload of the effect."""
         return {"patient": self.patient_id, "patient_filter": self.patient_filter, "key": self.key}
+
+
+__exports__ = ("RemoveBannerAlert",)

canvas_sdk/effects/base.py

@@ -26,3 +26,10 @@ class _BaseEffect(Model):
     def apply(self) -> Effect:
         self._validate_before_effect("apply")
         return Effect(type=self.Meta.effect_type, payload=json.dumps(self.effect_payload))
+
+
+__exports__ = (
+    "_BaseEffect",
+    # Not defined here but used in a current plugin
+    "EffectType",
+)

canvas_sdk/effects/billing_line_item/__init__.py

@@ -8,4 +8,8 @@ from canvas_sdk.effects.billing_line_item.update_billing_line_item import (
     UpdateBillingLineItem,
 )
 
-__all__ = ("AddBillingLineItem", "UpdateBillingLineItem", "RemoveBillingLineItem")
+__all__ = __exports__ = (
+    "AddBillingLineItem",
+    "UpdateBillingLineItem",
+    "RemoveBillingLineItem",
+)

canvas_sdk/effects/billing_line_item/add_billing_line_item.py

@@ -36,3 +36,6 @@ class AddBillingLineItem(_BaseEffect):
             "note_id": self.note_id,
             "data": self.values,
         }
+
+
+__exports__ = ("AddBillingLineItem",)

canvas_sdk/effects/billing_line_item/remove_billing_line_item.py

@@ -20,3 +20,6 @@ class RemoveBillingLineItem(_BaseEffect):
         return {
             "billing_line_item_id": self.billing_line_item_id,
         }
+
+
+__exports__ = ("RemoveBillingLineItem",)

canvas_sdk/effects/billing_line_item/update_billing_line_item.py

@@ -42,3 +42,6 @@ class UpdateBillingLineItem(_BaseEffect):
             "billing_line_item_id": self.billing_line_item_id,
             "data": self.values,
         }
+
+
+__exports__ = ("UpdateBillingLineItem",)

canvas_sdk/effects/launch_modal.py

@@ -34,3 +34,6 @@ class LaunchModalEffect(_BaseEffect):
             raise ValueError("'url' and 'content' are mutually exclusive")
 
         return self
+
+
+__exports__ = ("LaunchModalEffect",)

canvas_sdk/effects/patient_chart_summary_configuration.py

@@ -38,3 +38,6 @@ class PatientChartSummaryConfiguration(_BaseEffect):
     def effect_payload(self) -> dict[str, Any]:
         """The payload of the effect."""
         return {"data": self.values}
+
+
+__exports__ = ("PatientChartSummaryConfiguration",)

canvas_sdk/effects/patient_portal/__init__.py

@@ -0,0 +1 @@
+__exports__ = ()

canvas_sdk/effects/patient_portal/application_configuration.py

@@ -20,3 +20,6 @@ class PatientPortalApplicationConfiguration(_BaseEffect):
     def effect_payload(self) -> dict[str, Any]:
         """The payload of the effect."""
         return {"data": self.values}
+
+
+__exports__ = ("PatientPortalApplicationConfiguration",)

canvas_sdk/effects/patient_portal/form_result.py

@@ -29,3 +29,6 @@ class FormResult(_BaseEffect):
     def effect_payload(self) -> dict[str, Any]:
         """The payload of the effect."""
         return {"data": self.values}
+
+
+__exports__ = ("FormResult",)

canvas_sdk/effects/patient_portal_menu_configuration.py

@@ -34,3 +34,6 @@ class PatientPortalMenuConfiguration(_BaseEffect):
     def effect_payload(self) -> dict[str, Any]:
         """The payload of the effect."""
         return {"data": self.values}
+
+
+__exports__ = ("PatientPortalMenuConfiguration",)

canvas_sdk/effects/patient_profile_configuration.py

@@ -9,7 +9,8 @@ from canvas_sdk.effects.base import EffectType, _BaseEffect
 
 class PatientProfileConfiguration(_BaseEffect):
     """
-    An Effect that will decide which sections appear, and if they start expanded, on the patient's profile in Canvas.
+    An Effect that will decide which sections appear, and if they start expanded,
+    on the patient's profile in Canvas.
     """
 
     class Meta:
@@ -17,6 +18,7 @@ class PatientProfileConfiguration(_BaseEffect):
 
     class Section(Enum):
         DEMOGRAPHICS = "demographics"
+        PORTAL = "portal"
         PREFERENCES = "preferences"
         PREFERRED_PHARMACIES = "preferred_pharmacies"
         PATIENT_CONSENTS = "patient_consents"
@@ -41,3 +43,6 @@ class PatientProfileConfiguration(_BaseEffect):
     def effect_payload(self) -> dict[str, Any]:
         """The payload of the effect."""
         return {"data": self.values}
+
+
+__exports__ = ("PatientProfileConfiguration",)

canvas_sdk/effects/protocol_card/__init__.py

@@ -1,3 +1,3 @@
 from canvas_sdk.effects.protocol_card.protocol_card import ProtocolCard, Recommendation
 
-__all__ = ("ProtocolCard", "Recommendation")
+__all__ = __exports__ = ("ProtocolCard", "Recommendation")

canvas_sdk/effects/protocol_card/protocol_card.py

@@ -93,3 +93,9 @@ class ProtocolCard(_BaseEffect):
             title=title, button=button, href=href, command=command, context=context
         )
         self.recommendations.append(recommendation)
+
+
+__exports__ = (
+    "Recommendation",
+    "ProtocolCard",
+)

canvas_sdk/effects/questionnaire_result.py

@@ -27,3 +27,6 @@ class CreateQuestionnaireResult(_BaseEffect):
             "code_system": self.code_system,
             "code": self.code,
         }
+
+
+__exports__ = ("CreateQuestionnaireResult",)

canvas_sdk/effects/send_invite.py

@@ -0,0 +1,46 @@
+from typing import Any
+
+from pydantic_core import InitErrorDetails
+
+from canvas_sdk.effects.base import EffectType, _BaseEffect
+from canvas_sdk.v1.data import CanvasUser
+
+
+class SendInviteEffect(_BaseEffect):
+    """
+    An Effect that will send an invitation for the Patient Portal.
+    """
+
+    class Meta:
+        effect_type = EffectType.PATIENT_PORTAL__SEND_INVITE
+
+    user_dbid: int
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """The user's id."""
+        return {"user_dbid": self.user_dbid}
+
+    @property
+    def effect_payload(self) -> dict[str, Any]:
+        """The payload of the effect."""
+        return {"data": self.values}
+
+    def _get_error_details(self, method: Any) -> list[InitErrorDetails]:
+        errors = super()._get_error_details(method)
+
+        user_exists = CanvasUser.objects.filter(dbid=self.user_dbid).exists()
+
+        if not user_exists:
+            errors.append(
+                self._create_error_detail(
+                    "value",
+                    "User does not exist",
+                    self.user_dbid,
+                )
+            )
+
+        return errors
+
+
+__exports__ = ("SendInviteEffect",)

canvas_sdk/effects/show_button.py

@@ -27,3 +27,6 @@ class ShowButtonEffect(_BaseEffect):
     def effect_payload(self) -> dict[str, Any]:
         """The payload of the effect."""
         return {"data": self.values}
+
+
+__exports__ = ("ShowButtonEffect",)

canvas_sdk/effects/simple_api.py

@@ -81,3 +81,12 @@ class HTMLResponse(Response):
         headers: Mapping[str, Any] | None = None,
     ):
         super().__init__(content.encode(), status_code, headers, content_type="text/html")
+
+
+__exports__ = (
+    "JSON",
+    "Response",
+    "JSONResponse",
+    "PlainTextResponse",
+    "HTMLResponse",
+)

canvas_sdk/effects/surescripts/__init__.py

@@ -4,8 +4,8 @@ from .surescripts_messages import (
     SendSurescriptsMedicationHistoryRequestEffect,
 )
 
-__all__ = [
+__all__ = __exports__ = (
     "SendSurescriptsBenefitsRequestEffect",
     "SendSurescriptsEligibilityRequestEffect",
     "SendSurescriptsMedicationHistoryRequestEffect",
-]
+)

canvas_sdk/effects/surescripts/surescripts_messages.py

@@ -91,3 +91,10 @@ class SendSurescriptsBenefitsRequestEffect(_BaseEffect):
     def effect_payload(self) -> dict[str, Any]:
         """Benefits Request effect payload."""
         return self.values
+
+
+__exports__ = (
+    "SendSurescriptsBenefitsRequestEffect",
+    "SendSurescriptsEligibilityRequestEffect",
+    "SendSurescriptsMedicationHistoryRequestEffect",
+)

canvas_sdk/effects/task/__init__.py

@@ -1,3 +1,8 @@
 from .task import AddTask, AddTaskComment, TaskStatus, UpdateTask
 
-__all__ = ["AddTask", "AddTaskComment", "TaskStatus", "UpdateTask"]
+__all__ = __exports__ = (
+    "AddTask",
+    "AddTaskComment",
+    "TaskStatus",
+    "UpdateTask",
+)

canvas_sdk/effects/task/task.py

@@ -100,3 +100,11 @@ class UpdateTask(_BaseEffect):
             else:
                 value_dict[field] = getattr(self, field)
         return value_dict
+
+
+__exports__ = (
+    "AddTask",
+    "AddTaskComment",
+    "TaskStatus",
+    "UpdateTask",
+)

canvas_sdk/effects/update_user.py

@@ -0,0 +1,81 @@
+from typing import Any, Self
+
+from pydantic import model_validator
+from pydantic_core import InitErrorDetails
+
+from canvas_sdk.effects.base import EffectType, _BaseEffect
+from canvas_sdk.v1.data import CanvasUser
+
+
+class UpdateUserEffect(_BaseEffect):
+    """
+    An Effect that will update the user properties.
+    """
+
+    class Meta:
+        effect_type = EffectType.UPDATE_USER
+
+    # A set to track which fields have been modified.
+    _dirty_keys: set[str] = set()
+
+    def __init__(self, /, **data: Any) -> None:
+        super().__init__(**data)
+        self._dirty_keys = set()
+        self._dirty_keys.update(data.keys())
+
+    def __setattr__(self, name: str, value: Any) -> None:
+        """Set an attribute and mark it as dirty unless excluded."""
+        if not name.startswith("_"):
+            self._dirty_keys.add(name)
+        super().__setattr__(name, value)
+
+    def is_dirty(self, key: str) -> bool:
+        """Returns True if the given property has been modified (i.e. marked as dirty), False otherwise."""
+        return key in self._dirty_keys
+
+    user_dbid: int
+    email: str | None = None
+    phone_number: str | None = None
+
+    @property
+    def values(self) -> dict[str, Any]:
+        """The user's values."""
+        result = {}
+
+        for key in self._dirty_keys:
+            result[key] = getattr(self, key)
+
+        result["dbid"] = self.user_dbid
+        return result
+
+    @property
+    def effect_payload(self) -> dict[str, Any]:
+        """The payload of the effect."""
+        return {"data": self.values}
+
+    @model_validator(mode="after")
+    def check_exclusive_fields(self) -> Self:
+        """Check that at least one of mutually exclusive field is set."""
+        if self.email is None and self.phone_number is None:
+            raise ValueError("one of 'email', 'phone_number' is required")
+
+        return self
+
+    def _get_error_details(self, method: Any) -> list[InitErrorDetails]:
+        errors = super()._get_error_details(method)
+
+        user_exists = CanvasUser.objects.filter(dbid=self.user_dbid).exists()
+
+        if not user_exists:
+            errors.append(
+                self._create_error_detail(
+                    "value",
+                    "User does not exist",
+                    self.user_dbid,
+                )
+            )
+
+        return errors
+
+
+__exports__ = ("UpdateUserEffect",)

canvas_sdk/effects/widgets/__init__.py

@@ -1,3 +1,3 @@
 from .portal_widget import PortalWidget
 
-__all__ = ["PortalWidget"]
+__all__ = __exports__ = ("PortalWidget",)

canvas_sdk/effects/widgets/portal_widget.py

@@ -74,3 +74,6 @@ class PortalWidget(_BaseEffect):
             )
 
         return errors
+
+
+__exports__ = ("PortalWidget",)

canvas_sdk/events/__init__.py

@@ -3,4 +3,9 @@ from canvas_generated.messages.events_pb2 import EventResponse, EventType
 
 from .base import Event
 
-__all__ = ("EventRequest", "EventResponse", "EventType", "Event")
+__all__ = __exports__ = (
+    "EventRequest",
+    "EventResponse",
+    "EventType",
+    "Event",
+)

canvas_sdk/events/base.py

@@ -46,3 +46,6 @@ class Event:
         self.name = EventType.Name(self.type)
         self.context = context
         self.target = TargetType(id=event_request.target, type=target_model)
+
+
+__exports__ = ("TargetType", "Event")

canvas_sdk/handlers/__init__.py

@@ -1,3 +1,3 @@
 from canvas_sdk.handlers.base import BaseHandler
 
-__all__ = ("BaseHandler",)
+__all__ = __exports__ = ("BaseHandler",)

canvas_sdk/handlers/action_button.py

@@ -78,3 +78,9 @@ class ActionButton(BaseHandler):
             return self.handle()
 
         return []
+
+
+__exports__ = (
+    "SHOW_BUTTON_REGEX",
+    "ActionButton",
+)

canvas_sdk/handlers/application.py

@@ -27,3 +27,6 @@ class Application(BaseHandler, ABC):
     def identifier(self) -> str:
         """The application identifier."""
         return f"{self.__class__.__module__}:{self.__class__.__qualname__}"
+
+
+__exports__ = ("Application",)

canvas_sdk/handlers/base.py

@@ -57,3 +57,6 @@ class BaseHandler(ABC):
     def accept_event(self) -> bool:
         """Determine whether an event should be accepted and handled by the handler."""
         return True
+
+
+__exports__ = ("BaseHandler",)

canvas_sdk/handlers/cron_task.py

@@ -33,3 +33,6 @@ class CronTask(BaseHandler):
         if datetime in Cron(self.SCHEDULE):
             return self.execute()
         return []
+
+
+__exports__ = ("CronTask",)

canvas_sdk/handlers/simple_api/__init__.py

@@ -12,7 +12,8 @@ from .security import (
     StaffSessionAuthMixin,
 )
 
-__all__ = [
+__all__ = __exports__ = (
+    "api",
     "APIKeyAuthMixin",
     "APIKeyCredentials",
     "AuthSchemeMixin",
@@ -25,4 +26,4 @@ __all__ = [
     "SimpleAPI",
     "SimpleAPIRoute",
     "StaffSessionAuthMixin",
-]
+)

canvas_sdk/handlers/simple_api/api.py

@@ -1,3 +1,4 @@
+import inspect
 import json
 import re
 import traceback
@@ -334,7 +335,10 @@ class SimpleAPIBase(BaseHandler, ABC):
         """Authenticate the request."""
         try:
             # Create the credentials object
-            credentials_cls = self.authenticate.__annotations__.get("credentials")
+            credentials_cls = inspect.get_annotations(self.authenticate, eval_str=True).get(
+                "credentials"
+            )
+
             if not credentials_cls or not issubclass(credentials_cls, Credentials):
                 raise PluginError(
                     f"Cannot determine authentication scheme for {self.request.path}; "
@@ -512,3 +516,24 @@ class SimpleAPIRoute(SimpleAPIBase, ABC):
     def patch(self) -> list[Response | Effect]:
         """Stub method for PATCH handler."""
         return []
+
+
+__exports__ = (
+    "FormPart",
+    "StringFormPart",
+    "FileFormPart",
+    "parse_multipart_form",
+    "Request",
+    "SimpleAPIType",
+    "RouteHandler",
+    "get",
+    "post",
+    "put",
+    "delete",
+    "patch",
+    "SimpleAPIBase",
+    "SimpleAPI",
+    "SimpleAPIRoute",
+    # Not defined here but used in an existing plugin
+    "Credentials",
+)

canvas_sdk/handlers/simple_api/exceptions.py

@@ -37,3 +37,13 @@ class InvalidCredentialsError(AuthenticationError):
 
     def __init__(self) -> None:
         super().__init__("Provided credentials are invalid")
+
+
+__exports__ = (
+    "SimpleAPIException",
+    "AuthenticationError",
+    "NoAuthorizationHeaderError",
+    "AuthenticationSchemeError",
+    "InvalidCredentialsFormatError",
+    "InvalidCredentialsError",
+)