canvas 0.45.0__py3-none-any.whl → 0.46.0__py3-none-any.whl

canvas_sdk/v1/data/staff.py

@@ -2,6 +2,7 @@ from django.contrib.postgres.fields import ArrayField
 from django.db import models
 from timezone_utils.fields import TimeZoneField
 
+from canvas_sdk.v1.data.base import IdentifiableModel, Model
 from canvas_sdk.v1.data.common import (
     AddressState,
     AddressType,
@@ -12,53 +13,58 @@ from canvas_sdk.v1.data.common import (
     PersonSex,
     TaxIDType,
 )
+from canvas_sdk.v1.data.utils import create_key
 
 
-class Staff(models.Model):
+class Staff(Model):
     """Staff."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_staff_001"
 
     def __str__(self) -> str:
         return f"{self.first_name} {self.last_name}"
 
-    id = models.CharField(max_length=32, db_column="key")
-    dbid = models.BigIntegerField(db_column="dbid", primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
-    prefix = models.CharField()
-    suffix = models.CharField()
-    first_name = models.CharField()
-    middle_name = models.CharField()
-    last_name = models.CharField()
-    maiden_name = models.CharField()
-    nickname = models.CharField()
+    id = models.CharField(
+        max_length=32,
+        db_column="key",
+        unique=True,
+        editable=False,
+        default=create_key,
+    )
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
+    prefix = models.CharField(max_length=100)
+    suffix = models.CharField(max_length=100)
+    first_name = models.CharField(max_length=255)
+    middle_name = models.CharField(max_length=255)
+    last_name = models.CharField(max_length=255)
+    maiden_name = models.CharField(max_length=255)
+    nickname = models.CharField(max_length=255)
     previous_names = models.JSONField()
     birth_date = models.DateField(null=True)
-    sex_at_birth = models.CharField(choices=PersonSex.choices)
-    sexual_orientation_term = models.CharField()
-    sexual_orientation_code = models.CharField()
-    gender_identity_term = models.CharField()
-    gender_identity_code = models.CharField()
-    preferred_pronouns = models.CharField()
-    biological_race_codes = ArrayField(models.CharField())
-    biological_race_terms = ArrayField(models.CharField())
-    cultural_ethnicity_codes = ArrayField(models.CharField())
-    cultural_ethnicity_terms = ArrayField(models.CharField())
+    sex_at_birth = models.CharField(choices=PersonSex.choices, max_length=3)
+    sexual_orientation_term = models.CharField(max_length=255)
+    sexual_orientation_code = models.CharField(max_length=255)
+    gender_identity_term = models.CharField(max_length=255)
+    gender_identity_code = models.CharField(max_length=255)
+    preferred_pronouns = models.CharField(max_length=255)
+    biological_race_codes = ArrayField(models.CharField(max_length=100))
+    biological_race_terms = ArrayField(models.CharField(max_length=255))
+    cultural_ethnicity_codes = ArrayField(models.CharField(max_length=100))
+    cultural_ethnicity_terms = ArrayField(models.CharField(max_length=255))
     last_known_timezone = TimeZoneField(null=True)
     active = models.BooleanField()
     primary_practice_location = models.ForeignKey(
         "v1.PracticeLocation", on_delete=models.DO_NOTHING, null=True
     )
-    npi_number = models.CharField()
-    nadean_number = models.CharField()
-    group_npi_number = models.CharField()
+    npi_number = models.CharField(max_length=10)
+    nadean_number = models.CharField(max_length=20)
+    group_npi_number = models.CharField(max_length=10)
     bill_through_organization = models.BooleanField()
-    tax_id = models.CharField()
-    tax_id_type = models.CharField(choices=TaxIDType.choices)
-    spi_number = models.CharField()
+    tax_id = models.CharField(max_length=25)
+    tax_id_type = models.CharField(choices=TaxIDType.choices, max_length=1)
+    spi_number = models.CharField(max_length=50)
     # TODO - uncomment when Language is developed
     # language = models.ForeignKey('v1.Language', on_delete=models.DO_NOTHING, related_name="staff_speakers", null=True)
     # language_secondary = models.ForeignKey('v1.Language', on_delete=models.DO_NOTHING, related_name="staff_secondary_speakers", null=True)
@@ -70,61 +76,59 @@ class Staff(models.Model):
         "v1.Staff", on_delete=models.DO_NOTHING, related_name="supervising_team", null=True
     )
 
+    @property
+    def photo_url(self) -> str:
+        """Return the URL of the staff's first photo."""
+        photo = self.photos.first()
+        return photo.url if photo else "https://d3hn0m4rbsz438.cloudfront.net/avatar1.png"
+
 
-class StaffContactPoint(models.Model):
+class StaffContactPoint(IdentifiableModel):
     """StaffContactPoint."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_staffcontactpoint_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    system = models.CharField(choices=ContactPointSystem.choices)
-    value = models.CharField()
-    use = models.CharField(choices=ContactPointUse.choices)
-    use_notes = models.CharField()
+    system = models.CharField(choices=ContactPointSystem.choices, max_length=20)
+    value = models.CharField(max_length=100)
+    use = models.CharField(choices=ContactPointUse.choices, max_length=20)
+    use_notes = models.CharField(max_length=255)
     rank = models.IntegerField()
-    state = models.CharField(choices=ContactPointState.choices)
+    state = models.CharField(choices=ContactPointState.choices, max_length=20)
     staff = models.ForeignKey(Staff, on_delete=models.DO_NOTHING, related_name="telecom")
 
 
-class StaffAddress(models.Model):
+class StaffAddress(IdentifiableModel):
     """StaffAddress."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_staffaddress_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    line1 = models.CharField()
-    line2 = models.CharField()
-    city = models.CharField()
-    district = models.CharField()
-    state_code = models.CharField()
-    postal_code = models.CharField()
-    use = models.CharField(choices=AddressUse.choices)
-    type = models.CharField(choices=AddressType.choices)
+    line1 = models.CharField(max_length=255)
+    line2 = models.CharField(max_length=255)
+    city = models.CharField(max_length=255)
+    district = models.CharField(max_length=255)
+    state_code = models.CharField(max_length=2)
+    postal_code = models.CharField(max_length=255)
+    use = models.CharField(choices=AddressUse.choices, max_length=10)
+    type = models.CharField(choices=AddressType.choices, max_length=10)
     longitude = models.FloatField()
     latitude = models.FloatField()
     start = models.DateField()
     end = models.DateField()
-    country = models.CharField()
-    state = models.CharField(choices=AddressState.choices)
+    country = models.CharField(max_length=255)
+    state = models.CharField(choices=AddressState.choices, max_length=20)
     staff = models.ForeignKey(Staff, on_delete=models.DO_NOTHING, related_name="addresses")
 
 
-class StaffPhoto(models.Model):
+class StaffPhoto(Model):
     """StaffPhoto."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_staffphoto_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
     staff = models.ForeignKey(Staff, on_delete=models.CASCADE, related_name="photos")
     url = models.CharField(
         default="https://d3hn0m4rbsz438.cloudfront.net/avatar1.png", max_length=512

canvas_sdk/v1/data/task.py

@@ -1,20 +1,21 @@
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
+from canvas_sdk.v1.data.base import IdentifiableModel, Model
 from canvas_sdk.v1.data.common import ColorEnum, Origin
 
 
 class TaskType(models.TextChoices):
     """Choices for task types."""
 
-    TASK = "Task", "Task"
-    REMINDER = "Reminder", "Reminder"
+    TASK = "T", "Task"
+    REMINDER = "R", "Reminder"
 
 
 class EventType(models.TextChoices):
     """Choices for event types."""
 
-    EVENT_CHART_OPEN = "Chart Open", "Chart Open"
+    EVENT_CHART_OPEN = "CHART_OPEN", "Chart Open"
 
 
 class TaskStatus(models.TextChoices):
@@ -32,17 +33,14 @@ class TaskLabelModule(models.TextChoices):
     TASKS = "tasks", "Tasks"
 
 
-class Task(models.Model):
+class Task(IdentifiableModel):
     """Task."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_task_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
     creator = models.ForeignKey(
         "v1.Staff", on_delete=models.DO_NOTHING, related_name="creator_tasks", null=True
     )
@@ -54,25 +52,22 @@ class Task(models.Model):
     patient = models.ForeignKey(
         "v1.Patient", on_delete=models.DO_NOTHING, blank=True, related_name="tasks", null=True
     )
-    task_type = models.CharField(choices=TaskType.choices)
-    tag = models.CharField()
-    title = models.CharField()
+    task_type = models.CharField(choices=TaskType.choices, max_length=1)
+    tag = models.CharField(max_length=64)
+    title = models.TextField()
     due = models.DateTimeField(null=True)
-    due_event = models.CharField(choices=EventType.choices, blank=True)
-    status = models.CharField(choices=TaskStatus.choices)
+    due_event = models.CharField(choices=EventType.choices, blank=True, max_length=16)
+    status = models.CharField(choices=TaskStatus.choices, max_length=9)
 
 
-class TaskComment(models.Model):
+class TaskComment(IdentifiableModel):
     """TaskComment."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_taskcomment_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
     creator = models.ForeignKey(
         "v1.Staff", on_delete=models.DO_NOTHING, related_name="comments", null=True
     )
@@ -80,32 +75,27 @@ class TaskComment(models.Model):
     body = models.TextField()
 
 
-class TaskLabel(models.Model):
+class TaskLabel(IdentifiableModel):
     """TaskLabel."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_tasklabel_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
     tasks = models.ManyToManyField(Task, related_name="labels", through="TaskTaskLabel")  # type: ignore[var-annotated]
     position = models.IntegerField()
-    color = models.CharField(choices=ColorEnum.choices)
-    task_association = ArrayField(models.CharField(choices=Origin.choices))
-    name = models.CharField()
+    color = models.CharField(choices=ColorEnum.choices, max_length=50)
+    task_association = ArrayField(models.CharField(choices=Origin.choices, max_length=32))
+    name = models.CharField(max_length=255)
     active = models.BooleanField()
-    modules = ArrayField(models.CharField(choices=TaskLabelModule.choices))
+    modules = ArrayField(models.CharField(choices=TaskLabelModule.choices, max_length=32))
 
 
-class TaskTaskLabel(models.Model):
+class TaskTaskLabel(Model):
     """M2M for Task -> TaskLabels."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_tasktasklabel_001"
 
-    dbid = models.BigIntegerField(primary_key=True)
     task_label = models.ForeignKey(TaskLabel, on_delete=models.DO_NOTHING, null=True)
     task = models.ForeignKey(Task, on_delete=models.DO_NOTHING, null=True)
 

canvas_sdk/v1/data/team.py

@@ -1,6 +1,7 @@
 from django.contrib.postgres.fields import ArrayField
 from django.db import models
 
+from canvas_sdk.v1.data.base import IdentifiableModel
 from canvas_sdk.v1.data.common import ContactPointState, ContactPointSystem, ContactPointUse
 
 
@@ -38,41 +39,37 @@ class TeamResponsibility(models.TextChoices):
     REVIEW_COVERAGES = "REVIEW_COVERAGES", "Review incomplete patient coverages"
 
 
-class Team(models.Model):
+class Team(IdentifiableModel):
     """Team."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_team_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    created = models.DateTimeField()
-    modified = models.DateTimeField()
-    name = models.CharField()
-    responsibilities = ArrayField(models.CharField(choices=TeamResponsibility.choices))
-    members = models.ManyToManyField(  # type: ignore[var-annotated]
+    created = models.DateTimeField(auto_now_add=True)
+    modified = models.DateTimeField(auto_now=True)
+    name = models.CharField(max_length=200)
+    responsibilities = ArrayField(
+        models.CharField(choices=TeamResponsibility.choices, max_length=64)
+    )
+    members = models.ManyToManyField(
         "v1.Staff",
         related_name="teams",
         db_table="canvas_sdk_data_api_team_members_001",
     )
 
 
-class TeamContactPoint(models.Model):
+class TeamContactPoint(IdentifiableModel):
     """TeamContactPoint."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_teamcontactpoint_001"
 
-    id = models.UUIDField()
-    dbid = models.BigIntegerField(primary_key=True)
-    system = models.CharField(choices=ContactPointSystem.choices)
-    value = models.CharField()
-    use = models.CharField(choices=ContactPointUse.choices)
-    use_notes = models.CharField()
+    system = models.CharField(choices=ContactPointSystem.choices, max_length=20)
+    value = models.CharField(max_length=100)
+    use = models.CharField(choices=ContactPointUse.choices, max_length=20)
+    use_notes = models.CharField(max_length=255)
     rank = models.IntegerField()
-    state = models.CharField(choices=ContactPointState.choices)
+    state = models.CharField(choices=ContactPointState.choices, max_length=20)
     team = models.ForeignKey(Team, on_delete=models.DO_NOTHING, related_name="telecom")
 
 

canvas_sdk/v1/data/user.py

@@ -1,14 +1,14 @@
 from django.db import models
 
+from canvas_sdk.v1.data.base import Model
 
-class CanvasUser(models.Model):
+
+class CanvasUser(Model):
     """A class representing a Canvas User."""
 
     class Meta:
-        managed = False
         db_table = "canvas_sdk_data_api_auth_user_001"
 
-    dbid = models.BigIntegerField(db_column="dbid", primary_key=True)
     email = models.EmailField(db_column="email")
     phone_number = models.CharField(db_column="phone_number", max_length=255)
     last_invite_date_time = models.DateTimeField()

canvas_sdk/v1/data/utils.py

@@ -1,3 +1,4 @@
+import uuid
 from collections.abc import Sequence
 from decimal import Decimal
 
@@ -7,4 +8,9 @@ def quantize(deci: Decimal | float | str | tuple[int, Sequence[int], int]) -> De
     return Decimal(deci).quantize(Decimal(".01"))
 
 
+def create_key() -> str:
+    """Generates a unique key using UUID4."""
+    return uuid.uuid4().hex
+
+
 __exports__ = ()