django-ctct 0.0.1.dev4__tar.gz → 0.0.1.dev5__tar.gz

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev5}/PKG-INFO

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: django-ctct
-Version: 0.0.1.dev4
+Version: 0.0.1.dev5
 Summary: A Django interface for the Constant Contact API
 License: MIT
+License-File: LICENSE
 Author: Geoffrey Eisenbarth
 Author-email: geoffrey.eisenbarth@gmail.com
 Requires-Python: >=3.10
@@ -12,7 +13,9 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: django (>=3.2.0,<6.0.0)
+Requires-Dist: mypy (>=1.19.0,<2.0.0)
 Requires-Dist: pyjwt[crypto] (>=2.10.1,<3.0.0)
 Requires-Dist: ratelimit (>=2.2.1,<3.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
@@ -25,7 +28,9 @@ Description-Content-Type: text/markdown
 
 This Django app provides a seamless interface to the Constant Contact API, allowing you to manage contacts, email campaigns, and other Constant Contact functionalities directly from your Django project.
 
-**Warning:** This package is under active development. While it is our intention to develop with a consistent API going forward, we will not make promises until a later version is released.
+**Warning:** This package is under active development.
+While it is our intention to develop with a consistent API going forward, we will not make promises until a later version is released.
+
 
 ## Installation
 
@@ -33,6 +38,7 @@ This Django app provides a seamless interface to the Constant Contact API, allow
 pip install django-ctct
 ```
 
+
 ## Configuration
 
 1) **Add to `INSTALLED_APPS`:**
@@ -61,6 +67,7 @@ urlpatterns = [
   # ... other URL patterns
 ]
 ```
+
 3) **ConstantContact API Credentials:**
 
 Head to https://app.constantcontact.com/pages/dma/portal/ to set up your application with ConstantContact.
@@ -110,6 +117,7 @@ CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct
   * `CTCT_PREVIEW_MESSAGE` will be blank by default.
 
 3) **Run Migrations:**
+
 ```bash
 > ./manage.py makemigrations
 > ./manage.py migrate
@@ -118,9 +126,10 @@ CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct
 4) **Create Authenticatin Token:**
 
 After the app has been installed and configured, you must generate your first auth token:
-  * Open up the `CTCT_REDIRECT_URI` address in your browser
-  * Use your ConstantContact credentials to log in
-  * From this point forward `django-ctct` should use refresh tokens, so no need to manually log in again
+
+ * Open up the `CTCT_REDIRECT_URI` address in your browser
+ * Use your ConstantContact credentials to log in
+ * From this point forward `django-ctct` should use refresh tokens, so no need to manually log in again
 
 
 ## Usage
@@ -130,12 +139,16 @@ If you wish to import data from ConstantContact.com into your local database (re
 > ./manage.py import_ctct
 ```
 
-You will be asked before each model type is imported. **Note** ConstantContact does not provide a bulk API endpoint for fetching Campaign Activities, so depending on the size of your account, this might take some time and possible put you over their 10,000 request per day limit if you run it regularly.
+You will be asked before each model type is imported.
+**Note** ConstantContact does not provide a bulk API endpoint for fetching Campaign Activities, so depending on the size of your account, this might take some time and possible put you over their 10,000 request per day limit if you run it regularly.
 
-Since ConstantContact does not offer any webhooks, you will need to set up a cron job if you want your account to remain syncronized with ConstantContact's database. You can use the `--no-input` flag to bypass the interactive questions. The `--stats-only` flag is useful for running a cron job to keep EmailCampaign statistics updated.
+Since ConstantContact does not offer any webhooks, you will need to set up a cron job if you want your account to remain syncronized with ConstantContact's database.
+You can use the `--no-input` flag to bypass the interactive questions.
+The `--stats-only` flag is useful for running a cron job to keep EmailCampaign statistics updated.
 
 If you wish to use the Django admin to interact with ConstantContact, you must explicitly set the `CTCT_USE_ADMIN` and `CTCT_SYNC_ADMIN` settings to `True`.
 
+
 ## Testing
 
 To install dev dependencies:
@@ -155,13 +168,16 @@ To run tests:
 > poetry run coverage report
 ```
 
+
 ## Contributing
 
 Once version 0.0.1 is released on PyPI, we hope to implement the following new features (in no particular order):
 
-  * Support for API syncing using signals (`post_save`, `pre_delete`, `m2m_changed`, etc). This will be controlled by the `CTCT_SYNC_SIGNALS` setting. **Update** This probably won't work as desired since the primary object will be saved before related objects are.
-  * Background task support using `django-tasks` (which hopefully will merge into Django). This will be controlled by the `CTCT_ENQUEUE_DEFAULT` setting. 
-  * Add `models.CheckConstraint` and `models.UniqueConstraint` constraints that are currently commented out.
+ * Support for API syncing using signals (`post_save`, `pre_delete`, `m2m_changed`, etc).
+ This will be controlled by the `CTCT_SYNC_SIGNALS` setting.
+ **Update** This probably won't work as desired since the primary object will be saved before related objects are.
+ * Background task support using `django-tasks` (which hopefully will merge into Django). This will be controlled by the `CTCT_ENQUEUE_DEFAULT` setting. 
+ * Add `models.CheckConstraint` and `models.UniqueConstraint` constraints that are currently commented out.
   
 
 I'm always open to new suggestions, so please reach out on GitHub: https://github.com/geoffrey-eisenbarth/django-ctct/

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev5}/README.md

@@ -4,7 +4,9 @@
 
 This Django app provides a seamless interface to the Constant Contact API, allowing you to manage contacts, email campaigns, and other Constant Contact functionalities directly from your Django project.
 
-**Warning:** This package is under active development. While it is our intention to develop with a consistent API going forward, we will not make promises until a later version is released.
+**Warning:** This package is under active development.
+While it is our intention to develop with a consistent API going forward, we will not make promises until a later version is released.
+
 
 ## Installation
 
@@ -12,6 +14,7 @@ This Django app provides a seamless interface to the Constant Contact API, allow
 pip install django-ctct
 ```
 
+
 ## Configuration
 
 1) **Add to `INSTALLED_APPS`:**
@@ -40,6 +43,7 @@ urlpatterns = [
   # ... other URL patterns
 ]
 ```
+
 3) **ConstantContact API Credentials:**
 
 Head to https://app.constantcontact.com/pages/dma/portal/ to set up your application with ConstantContact.
@@ -89,6 +93,7 @@ CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct
   * `CTCT_PREVIEW_MESSAGE` will be blank by default.
 
 3) **Run Migrations:**
+
 ```bash
 > ./manage.py makemigrations
 > ./manage.py migrate
@@ -97,9 +102,10 @@ CTCT_SYNC_ADMIN = False      # Django admin CRUD operations will sync with ctct
 4) **Create Authenticatin Token:**
 
 After the app has been installed and configured, you must generate your first auth token:
-  * Open up the `CTCT_REDIRECT_URI` address in your browser
-  * Use your ConstantContact credentials to log in
-  * From this point forward `django-ctct` should use refresh tokens, so no need to manually log in again
+
+ * Open up the `CTCT_REDIRECT_URI` address in your browser
+ * Use your ConstantContact credentials to log in
+ * From this point forward `django-ctct` should use refresh tokens, so no need to manually log in again
 
 
 ## Usage
@@ -109,12 +115,16 @@ If you wish to import data from ConstantContact.com into your local database (re
 > ./manage.py import_ctct
 ```
 
-You will be asked before each model type is imported. **Note** ConstantContact does not provide a bulk API endpoint for fetching Campaign Activities, so depending on the size of your account, this might take some time and possible put you over their 10,000 request per day limit if you run it regularly.
+You will be asked before each model type is imported.
+**Note** ConstantContact does not provide a bulk API endpoint for fetching Campaign Activities, so depending on the size of your account, this might take some time and possible put you over their 10,000 request per day limit if you run it regularly.
 
-Since ConstantContact does not offer any webhooks, you will need to set up a cron job if you want your account to remain syncronized with ConstantContact's database. You can use the `--no-input` flag to bypass the interactive questions. The `--stats-only` flag is useful for running a cron job to keep EmailCampaign statistics updated.
+Since ConstantContact does not offer any webhooks, you will need to set up a cron job if you want your account to remain syncronized with ConstantContact's database.
+You can use the `--no-input` flag to bypass the interactive questions.
+The `--stats-only` flag is useful for running a cron job to keep EmailCampaign statistics updated.
 
 If you wish to use the Django admin to interact with ConstantContact, you must explicitly set the `CTCT_USE_ADMIN` and `CTCT_SYNC_ADMIN` settings to `True`.
 
+
 ## Testing
 
 To install dev dependencies:
@@ -134,13 +144,16 @@ To run tests:
 > poetry run coverage report
 ```
 
+
 ## Contributing
 
 Once version 0.0.1 is released on PyPI, we hope to implement the following new features (in no particular order):
 
-  * Support for API syncing using signals (`post_save`, `pre_delete`, `m2m_changed`, etc). This will be controlled by the `CTCT_SYNC_SIGNALS` setting. **Update** This probably won't work as desired since the primary object will be saved before related objects are.
-  * Background task support using `django-tasks` (which hopefully will merge into Django). This will be controlled by the `CTCT_ENQUEUE_DEFAULT` setting. 
-  * Add `models.CheckConstraint` and `models.UniqueConstraint` constraints that are currently commented out.
+ * Support for API syncing using signals (`post_save`, `pre_delete`, `m2m_changed`, etc).
+ This will be controlled by the `CTCT_SYNC_SIGNALS` setting.
+ **Update** This probably won't work as desired since the primary object will be saved before related objects are.
+ * Background task support using `django-tasks` (which hopefully will merge into Django). This will be controlled by the `CTCT_ENQUEUE_DEFAULT` setting. 
+ * Add `models.CheckConstraint` and `models.UniqueConstraint` constraints that are currently commented out.
   
 
 I'm always open to new suggestions, so please reach out on GitHub: https://github.com/geoffrey-eisenbarth/django-ctct/

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev5}/django_ctct/admin.py

@@ -51,7 +51,7 @@ def catch_api_errors(func: Callable[P, None]) -> Callable[P, None]:
       if getattr(settings, 'CTCT_RAISE_FOR_API', False):
         raise e
       else:
-        self, request, *_ = args
+        self, request, *x = args
         assert isinstance(self, admin.ModelAdmin)
         assert isinstance(request, HttpRequest)
         self.message_user(
@@ -141,7 +141,7 @@ class RemoteModelAdmin(
   def delete_queryset(
     self,
     request: HttpRequest,
-    queryset: QuerySet[CTCTEndpointModel],
+    queryset: QuerySet[E],
   ) -> None:
     if self.remote_sync:
       queryset.model.remote.bulk_delete(queryset)
@@ -152,7 +152,7 @@ class RemoteModelAdmin(
   def save_related(
     self,
     request: HttpRequest,
-    form: ModelForm[CTCTEndpointModel],
+    form: ModelForm[E],
     formsets: list[BaseFormSet[ModelForm[Model]]],
     change: bool,
   ) -> None:
@@ -175,7 +175,7 @@ class RemoteModelAdmin(
   def save_remotely(
     self,
     request: HttpRequest,
-    form: ModelForm[CTCTEndpointModel],
+    form: ModelForm[E],
     formsets: list[BaseFormSet[ModelForm[Model]]],
     change: bool,
   ) -> None:
@@ -295,7 +295,7 @@ class ContactCustomFieldInline(
 ):
 
   model = ContactCustomField
-  excldue = ('api_id', )
+  exclude = ('api_id', )
 
   extra = 0
 
@@ -570,7 +570,7 @@ class EmailCampaignAdmin(RemoteModelAdmin[EmailCampaign]):
   def save_remotely(
     self,
     request: HttpRequest,
-    form: ModelForm[EmailCampaign],  # type: ignore[override]
+    form: ModelForm[EmailCampaign],
     formsets: list[BaseFormSet[ModelForm[Model]]],
     change: bool,
   ) -> None:

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev5}/django_ctct/management/commands/import_ctct.py

@@ -82,12 +82,13 @@ class Command(BaseCommand):
 
     if model._meta.auto_created and hasattr(model, 'contactlist_id'):
       # Delete existing through model instances
-      model.objects.all().delete()
+      model.objects.all().delete()  # type: ignore
       update_conflicts = False
       unique_fields = update_fields = None
     elif issubclass(model, ContactCustomField):
-      update_conflicts = False
-      unique_fields = update_fields = None
+      update_conflicts = True
+      unique_fields = ['contact_id', 'custom_field_id']
+      update_fields = ['value']
     elif issubclass(model, CampaignSummary):
       update_conflicts = True
       unique_fields = ['campaign_id']
@@ -116,7 +117,7 @@ class Command(BaseCommand):
       unique_objs = objs
 
     # Perform the upsert
-    objs_w_pks = model.objects.bulk_create(
+    objs_w_pks = model.objects.bulk_create(  # type: ignore
       objs=unique_objs,
       update_conflicts=update_conflicts,
       unique_fields=unique_fields,
@@ -132,76 +133,34 @@ class Command(BaseCommand):
     # Inform the user
     if not silent:
       message = self.style.SUCCESS(
-        f'{verb} {len(objs)} {model.__name__} instances.'
+        f'{verb} {len(objs):,} {model.__name__} instances.'
       )
       self.stdout.write(message)
 
     return objs_w_pks
 
-  def set_direct_object_pks(
-    self,
-    model: Type[M],
-    instances: list[M],
-  ) -> None:
-    """Sets Django pk values for OneToOne and ForeignKeys objects."""
-
-    otos, _, fks, _ = get_related_fields(model)
-
-    fields = otos + fks
-    for field in fields:
-      if id_to_pk := self.get_id_to_pk(field.related_model):
-        for o in instances:
-          setattr(o, field.attname, id_to_pk[str(getattr(o, field.attname))])
-
   def set_related_object_pks(
     self,
-    model: Type[M],
+    model: Type[E],
     objs_w_pks: list[M],
     per_obj_list_of_related_objs: list[list[RelatedObjects]],
   ) -> None:
-    """Sets Django pk values for ManyToMany and ReverseForeignKey objects."""
-
-    if not any(per_obj_list_of_related_objs):
-      return
-
-    _, m2ms, _, rfks = get_related_fields(model)
-
-    m2m_attnames = {
-      field.remote_field.through: (
-        field.m2m_column_name(), field.m2m_reverse_name()
-      )
-      for field in m2ms
-    }
-    if m2ms:
-      id_to_pk = {
-        m2m.remote_field.through: self.get_id_to_pk(m2m.related_model)
-        for m2m in m2ms
-      }
-
-    rfk_attnames = {
-      rel.related_model: rel.field.attname
-      for rel in rfks
+    _, mtms, _, rfks = get_related_fields(model)
+    field_name = {
+      field.remote_field.through: field.m2m_field_name()
+      for field in mtms
+    } | {
+      field.related_model: field.remote_field.name
+      for field in rfks
     }
 
-    if model is Contact:
-      # TODO: GH #14 ContactCustomField is kind of a ManyToMany
-      m2m_attnames[ContactCustomField] = (
-        rfk_attnames.pop(ContactCustomField), 'custom_field_id'
-      )
-      id_to_pk[ContactCustomField] = self.get_id_to_pk(CustomField)
-
-    for obj_w_pk, list_of_related_objs in zip(objs_w_pks, per_obj_list_of_related_objs):  # noqa: E501
-      for related_model, objs in list_of_related_objs:
-        if m2m_attname := m2m_attnames.get(related_model):
-          column_name, reverse_name = m2m_attname
-          for o in objs:
-            api_id = str(getattr(o, reverse_name))
-            setattr(o, column_name, obj_w_pk.pk)
-            setattr(o, reverse_name, id_to_pk[related_model][api_id])
-
-        elif rfk_attname := rfk_attnames.get(related_model):
-          for o in objs:
-            setattr(o, rfk_attname, obj_w_pk.pk)
+    for obj_w_pk, list_of_related_objs in zip(
+      objs_w_pks,
+      per_obj_list_of_related_objs,
+    ):
+      for related_model, related_objs in list_of_related_objs:
+        for related_obj in related_objs:
+          setattr(related_obj, field_name[related_model], obj_w_pk)
 
   def import_model(self, model: Type[E]) -> None:
     """Imports objects from CTCT into Django's database."""
@@ -223,18 +182,16 @@ class Command(BaseCommand):
       # No values returned
       return
 
-    # Convert API id to Django pks
-    self.set_direct_object_pks(model, objs)
-
     # Upsert models to get Django pks
     objs_w_pks = self.upsert(model, objs)
 
-    # Convert API ids to Django pks for related objects
-    self.set_related_object_pks(
-      model,
-      objs_w_pks,
-      per_obj_list_of_related_objs,
-    )
+    # Set Django object PK on related objects
+    if any(per_obj_list_of_related_objs):
+      self.set_related_object_pks(
+        model,
+        objs_w_pks,
+        per_obj_list_of_related_objs,
+      )
 
     # Reshape related_objs for efficiency
     dict_of_related_objs = defaultdict(list)
@@ -249,13 +206,9 @@ class Command(BaseCommand):
   def import_campaign_activities(self) -> None:
     """CampaignActivities must be imported one at a time."""
 
-    # First make sure CampaignActivity API id's are stored locally
+    # First, make sure all CampaignActivity API id's are stored locally
     EmailCampaign.remote.connect()
-    for campaign in EmailCampaign.objects.exclude(
-      api_id__isnull=True,
-      campaign_activities__role='primary_email',
-      campaign_activities__api_id__isnull=False,
-    ):
+    for campaign in EmailCampaign.objects.exclude(api_id__isnull=True):
       # Fetch from API
       assert isinstance(campaign.api_id, UUID)
       try:
@@ -272,7 +225,7 @@ class Command(BaseCommand):
                 obj.campaign_id = campaign.pk
                 obj.save()
 
-    # Now fetch CampaignActivity details
+    # Then, fetch CampaignActivity details
     CampaignActivity.remote.connect()
 
     activities = CampaignActivity.objects.filter(
@@ -304,12 +257,13 @@ class Command(BaseCommand):
       update_fields=['role', 'subject', 'preheader', 'html_content']
     )
 
-    # Convert API id to Django pk for related objects
-    self.set_related_object_pks(
-      CampaignActivity,
-      objs_w_pks,
-      per_obj_list_of_related_objs,
-    )
+    # Set Django object PK on related objects
+    if any(per_obj_list_of_related_objs):
+      self.set_related_object_pks(
+        CampaignActivity,
+        objs_w_pks,
+        per_obj_list_of_related_objs,
+      )
 
     # Reshape related_objs for efficiency
     dict_of_related_objs = defaultdict(list)

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev5}/django_ctct/managers.py

@@ -17,7 +17,7 @@ from requests.models import Response
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.db import models
-from django.db.models import signals, Model
+from django.db.models import signals
 from django.db.models.manager import Manager
 from django.db.models.query import QuerySet
 from django.http import HttpRequest, Http404
@@ -32,7 +32,7 @@ from django_ctct.vendor import mute_signals
 if TYPE_CHECKING:
   from django_ctct.models import (
     JsonDict, RelatedObjects,
-    EndpointMixin, CTCTModel, CTCTEndpointModel,
+    EndpointMixin, SerialModel, CTCTModel, CTCTEndpointModel,
     Token, ContactList, Contact,
     EmailCampaign, CampaignActivity, CampaignSummary,
   )
@@ -40,6 +40,7 @@ if TYPE_CHECKING:
 T = TypeVar('T', bound='EndpointMixin')
 E = TypeVar('E', bound='CTCTEndpointModel')
 C = TypeVar('C', bound='CTCTModel')
+S = TypeVar('S', bound='SerialModel')
 
 
 class ConnectionManagerMixin(Manager[T]):
@@ -183,13 +184,13 @@ class TokenRemoteManager(ConnectionManagerMixin['Token'], Manager['Token']):
     return token
 
 
-class Serializer(Manager[C]):
+class Serializer(Manager[S]):
 
   TS_FORMAT: ClassVar[str] = '%Y-%m-%dT%H:%M:%SZ'
 
   def serialize(
     self,
-    obj: C,
+    obj: S,
     field_types: Literal['editable', 'readonly', 'all'] = 'editable',
   ) -> JsonDict:
     """Convert from Django object to API request body."""
@@ -241,21 +242,15 @@ class Serializer(Manager[C]):
           data[field_name] = list(map(str, qs))
         elif hasattr(value.model, 'serializer'):
           # ReverseForeignKey: serialize QuerySet
+          if value.model.__name__ == 'ContactCustomField':
+            # Model behaves as a through model, must get related ids
+            field_types = 'all'
           qs = value.all()
           data[field_name] = [
             qs.model.serializer.serialize(o, field_types)
             for o in qs
           ]
-        elif value.model.__name__ == 'ContactCustomField':
-          # TODO: GH #14
-          data[field_name] = [
-            {
-              'custom_field_id': str(row['custom_field__api_id']),
-              'value': row['value'],
-            }
-            for row in value.values('custom_field__api_id', 'value')
-          ]
-      elif isinstance(value, Model):
+      elif isinstance(value, models.Model):
         raise NotImplementedError
       else:
         raise NotImplementedError
@@ -301,54 +296,50 @@ class Serializer(Manager[C]):
   ) -> tuple[JsonDict, list[RelatedObjects]]:
     """Deserialize ManyToManyFields and ReverseForeignKeys."""
 
-    from django_ctct.models import is_ctct, is_model
+    from django_ctct.models import is_model, is_serial
 
+    related_objs: RelatedObjects
     list_of_related_objs: list[RelatedObjects] = []
-    objs: list[Model]
+    objs: list[models.Model]
 
     _, m2ms, _, rfks = get_related_fields(self.model)
     for rfk_field in filter(lambda f: f.name in data, rfks):
       # Reverse ForeignKeys get deserialized into model instances
-      related_model = rfk_field.related_model
+      RelatedModel = rfk_field.related_model
       parent = {rfk_field.remote_field.attname: parent_pk}
-
-      if is_model(related_model) and (
-        related_model.__name__ == 'ContactCustomField'
-      ):
-        # TODO: GH #14
-        objs = [
-          related_model(**datum | parent)
-          for datum in data.pop(rfk_field.name)
-        ]
-      elif is_ctct(related_model):
+      if is_serial(RelatedModel):
         objs = [
-          related_model.serializer.deserialize(datum | parent)[0]
+          RelatedModel.serializer.deserialize(datum | parent)[0]
           for datum in data.pop(rfk_field.name)
         ]
       else:
         continue
 
       if objs:
-        related_objs = (related_model, objs)
+        related_objs = (RelatedModel, objs)
         list_of_related_objs.append(related_objs)
 
     for m2m_field in filter(lambda f: f.name in data, m2ms):
       # ManyToManyFields get deserialized into "through model" instances
-      # TODO: GH #12, why are we setting contact_id = api_id?
-      through_model = m2m_field.remote_field.through
-      if through_model is None:
-        continue
+      # NOTE: Contact.custom_field_set is handled by rfk of ContactCustomField
+      ThroughModel = m2m_field.remote_field.through
+      RelatedModel = m2m_field.related_model
 
-      objs = [
-        through_model(**{
-          m2m_field.m2m_column_name(): data['api_id'],
-          m2m_field.m2m_reverse_name(): related_obj_api_id,
-        })
-        for related_obj_api_id in data.pop(m2m_field.name)
-      ]
-      if objs:
-        related_objs = (through_model, objs)
-        list_of_related_objs.append(related_objs)
+      if is_model(ThroughModel) and is_model(RelatedModel):
+        related_obj_pks = RelatedModel.objects.filter(  # type: ignore
+          api_id__in=data.pop(m2m_field.name)
+        ).values_list('pk', flat=True)
+
+        objs = [
+          ThroughModel(**{
+            m2m_field.m2m_column_name(): parent_pk,  # Might be None
+            m2m_field.m2m_reverse_name(): related_obj_pk,
+          })
+          for related_obj_pk in related_obj_pks
+        ]
+        if objs:
+          related_objs = (ThroughModel, objs)
+          list_of_related_objs.append(related_objs)
 
     return (data, list_of_related_objs)
 
@@ -356,12 +347,13 @@ class Serializer(Manager[C]):
     self,
     data: JsonDict,
     pk: Optional[int] = None,
-  ) -> tuple[C, list[RelatedObjects]]:
+  ) -> tuple[S, list[RelatedObjects]]:
     """Convert from API response body to Django object."""
 
     # If API_ID_LABEL is not a model field name, it will be removed later
     data = data.copy()
-    data['api_id'] = data[self.model.API_ID_LABEL]
+    if hasattr(self.model, 'API_ID_LABEL'):
+      data['api_id'] = data[self.model.API_ID_LABEL]
 
     # Clean field values, must be done before field restriction
     model_fields = self.model._meta.get_fields()
@@ -382,6 +374,13 @@ class Serializer(Manager[C]):
       if k in [getattr(f, 'attname', f.name) for f in model_fields]
     }
 
+    # Convert any remaining API ids to Django PKs
+    for k, v in data.items():
+      if k.endswith('_id') and isinstance(v, str):
+        RelatedModel = self.model._meta.get_field(k).related_model
+        if RelatedModel is not None:
+          data[k] = RelatedModel.objects.get(api_id=v).pk  # type: ignore
+
     if pk:
       # Preserve unrelated db fields (e.g. EmailCampaign.send_preview)
       obj = self.model.objects.get(pk=pk)
@@ -424,9 +423,9 @@ class RemoteManager(
 
     # NOTE: We don't need to do anything with `related_objs` since they were
     #       set locally before the API request.
-    # TODO: GH #11?
     obj, _ = self.deserialize(data, pk=pk)
 
+    # TODO: GH #11?
     # Overwrite local obj with CTCT's response
     with mute_signals(signals.post_save):
       obj.save()
@@ -490,7 +489,7 @@ class RemoteManager(
       data = next(iter(metadata.values()))
       list_of_tuples += map(self.deserialize, data)
 
-      if links is not None:
+      if links:
         endpoint = links['next']['href']
       else:
         paginated = False
@@ -522,9 +521,9 @@ class RemoteManager(
 
     # NOTE: We don't need to do anything with `related_objs` since they were
     #       set locally before the API request.
-    # TODO: GH #11?
     obj, _ = self.deserialize(data, pk=pk)
 
+    # TODO: GH #11?
     # Overwrite local obj with CTCT's response
     with mute_signals(signals.post_save):
       obj.save()
@@ -602,7 +601,7 @@ class ContactListRemoteManager(RemoteManager['ContactList']):
 
     from django_ctct.models import is_ctct
 
-    Contact = self.model._meta.get_field('members').related_model
+    Contact = self.model._meta.get_field('members').related_model  # type: ignore # noqa: E501
     if is_ctct(Contact) and hasattr(Contact, 'API_ENDPOINT_BULK_LIMIT'):
       step_size = Contact.API_ENDPOINT_BULK_LIMIT
     else:
@@ -664,15 +663,15 @@ class ContactRemoteManager(RemoteManager['Contact']):
     when creating Contacts that may already exist in ConstantContact's
     database, even if they've been "deleted" before.
 
-    Updates to existing contacts are partial updates. This endpoint only
-    updates the fields that are included in the request body. Updates append
-    new contact lists or custom fields to the existing `list_memberships` or
-    `custom_fields` arrays.
+    Updates to existing contacts are partial updates and this endpoint will
+    only update the fields that are included in the request body. Updates
+    append new contact lists or custom fields the existing `list_memberships`
+    or `custom_fields` arrays. As a result, we cannot use this endpoint to
+    remove a list from `list_memberships`, but must use `.update()`.
 
     The PUT call (e.g. just using update()) will overwrite all properties not
     included in the request body with NULL, so the `serialize()` method must
-    includes all important fields. While the `create_or_update()` method
-    supports partial updates, it won't allow us to remove a ContactList.
+    includes all important fields.
 
     """
 
@@ -812,9 +811,9 @@ class EmailCampaignRemoteManager(RemoteManager['EmailCampaign']):
 
     # NOTE: We don't need to do anything with `related_objs` since they were
     #       set locally before the API request.
-    # TODO: GH #11?
     obj, _ = self.deserialize(data, pk=pk)
 
+    # TODO: GH #11?
     # Overwrite local obj with CTCT's response
     with mute_signals(signals.post_save):
       obj.save()

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev5}/django_ctct/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.20 on 2025-06-04 15:01
+# Generated by Django 4.2.20 on 2025-12-03 18:31
 
 from django.conf import settings
 from django.db import migrations, models
@@ -64,7 +64,7 @@ class Migration(migrations.Migration):
                 ('created_at', models.DateTimeField(default=django.utils.timezone.now, editable=False, verbose_name='Created At')),
                 ('updated_at', models.DateTimeField(default=django.utils.timezone.now, editable=False, verbose_name='Updated At')),
                 ('api_id', models.UUIDField(default=None, null=True, unique=True, verbose_name='API ID')),
-                ('label', models.CharField(help_text='The display name for the custom_field shown in the UI as free-form text', max_length=50, verbose_name='Label')),
+                ('label', models.CharField(help_text='The display name for the custom_field shown in the UI as free-form text', max_length=50, unique=True, verbose_name='Label')),
                 ('type', models.CharField(choices=[('string', 'Text'), ('date', 'Date')], default='string', help_text='Specifies the type of value the custom_field field accepts', max_length=6, verbose_name='Type')),
             ],
             options={
@@ -79,7 +79,7 @@ class Migration(migrations.Migration):
                 ('created_at', models.DateTimeField(default=django.utils.timezone.now, editable=False, verbose_name='Created At')),
                 ('updated_at', models.DateTimeField(default=django.utils.timezone.now, editable=False, verbose_name='Updated At')),
                 ('api_id', models.UUIDField(default=None, null=True, unique=True, verbose_name='API ID')),
-                ('name', models.CharField(max_length=80, verbose_name='Name')),
+                ('name', models.CharField(max_length=80, unique=True, verbose_name='Name')),
                 ('scheduled_datetime', models.DateTimeField(blank=True, help_text='Leave blank to unschedule', null=True, verbose_name='Scheduled')),
                 ('send_preview', models.BooleanField(default=False, verbose_name='Send Preview')),
                 ('current_status', models.CharField(choices=[('NONE', 'Processing'), ('DRAFT', 'Draft'), ('SCHEDULED', 'Scheduled'), ('EXECUTING', 'Executing'), ('DONE', 'Sent'), ('ERROR', 'Error'), ('REMOVED', 'Removed')], default='DRAFT', max_length=20, verbose_name='Current Status')),
@@ -169,6 +169,11 @@ class Migration(migrations.Migration):
                 'verbose_name_plural': 'Custom Fields',
             },
         ),
+        migrations.AddField(
+            model_name='contact',
+            name='custom_field_set',
+            field=models.ManyToManyField(through='django_ctct.ContactCustomField', to='django_ctct.customfield'),
+        ),
         migrations.AddField(
             model_name='contact',
             name='list_memberships',
@@ -217,6 +222,18 @@ class Migration(migrations.Migration):
                 'verbose_name_plural': 'Email Campaign Activities',
             },
         ),
+        migrations.AddConstraint(
+            model_name='contactstreetaddress',
+            constraint=models.UniqueConstraint(fields=('contact', 'kind'), name='django_ctct_unique_street_address'),
+        ),
+        migrations.AddConstraint(
+            model_name='contactphonenumber',
+            constraint=models.UniqueConstraint(fields=('contact', 'kind'), name='django_ctct_unique_phone_number'),
+        ),
+        migrations.AddConstraint(
+            model_name='contactcustomfield',
+            constraint=models.UniqueConstraint(fields=('contact', 'custom_field'), name='django_ctct_unique_custom_field'),
+        ),
         migrations.AddConstraint(
             model_name='campaignactivity',
             constraint=models.UniqueConstraint(fields=('campaign', 'role'), name='django_ctct_unique_campaign_activity'),

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev5}/django_ctct/models.py

@@ -166,14 +166,24 @@ class Token(CreatedAtMixin, EndpointMixin, Model):
     return data
 
 
-class CTCTModel(Model):
-  """Common CTCT model methods and properties."""
-
+class SerialModel(Model):
   API_ID_LABEL: str
   API_EDITABLE_FIELDS: tuple[str, ...] = tuple()
   API_READONLY_FIELDS: tuple[str, ...] = (
     'api_id',
   )
+
+  # Must explicitly specify both
+  objects: ClassVar[models.Manager[Self]] = models.Manager()
+  serializer: ClassVar[Serializer[Self]] = Serializer()
+
+  class Meta:
+    abstract = True
+
+
+class CTCTModel(SerialModel):
+  """Common CTCT model methods and properties."""
+
   API_MAX_LENGTH: dict[str, int] = {}
 
   api_id = models.UUIDField(
@@ -183,10 +193,6 @@ class CTCTModel(Model):
     verbose_name=_('API ID'),
   )
 
-  # Must explicitly specify both
-  objects: ClassVar[models.Manager[Self]] = models.Manager()
-  serializer: ClassVar[Serializer[Self]] = Serializer()
-
   class Meta:
     abstract = True
 
@@ -289,6 +295,66 @@ class ContactList(CreatedAtMixin, UpdatedAtMixin, CTCTEndpointModel):
     return self.name
 
 
+class ContactCustomField(SerialModel):
+  """Django implementation of a CTCT Contact's CustomField.
+
+  Notes
+  -----
+  CTCT does not provide UUIDs for these, so we do not inherit from CTCTModel.
+
+  """
+
+  API_EDITABLE_FIELDS = (
+    'value',
+  )
+  API_READONLY_FIELDS = (
+    'custom_field_id',
+  )
+  API_MAX_LENGTH = {
+    'value': 255,
+  }
+
+  contact = models.ForeignKey(
+    'Contact',
+    related_name='custom_fields',
+    on_delete=models.CASCADE,
+    verbose_name=_('Contact'),
+  )
+  custom_field = models.ForeignKey(
+    'CustomField',
+    related_name='contacts',
+    on_delete=models.CASCADE,
+    verbose_name=_('Field'),
+  )
+
+  value = models.CharField(
+    max_length=API_MAX_LENGTH['value'],
+    verbose_name=_('Value'),
+  )
+
+  class Meta:
+    verbose_name = _('Custom Field')
+    verbose_name_plural = _('Custom Fields')
+
+    constraints = [
+       models.UniqueConstraint(
+         fields=['contact', 'custom_field'],
+         name='django_ctct_unique_custom_field',
+       ),
+       # models.CheckConstraint(   # TODO: GH #8
+       #   check=Q(contact__custom_fields__count__lte=ContactRemoteManager.API_MAX_NUM['custom_fields']),
+       #   name='django_ctct_limit_custom_fields',
+       # ),
+    ]
+
+  def __str__(self) -> str:
+    try:
+      s = f'[{self.custom_field.label}] {self.value}'
+    except CustomField.DoesNotExist:
+      s = super().__str__()
+    return s
+
+
 class CustomField(CreatedAtMixin, UpdatedAtMixin, CTCTEndpointModel):
   """Django implementation of a CTCT Contact's CustomField."""
 
@@ -303,13 +369,11 @@ class CustomField(CreatedAtMixin, UpdatedAtMixin, CTCTEndpointModel):
   )
   API_READONLY_FIELDS = (
     'api_id',
-    'name',
     'created_at',
     'updated_at',
   )
   API_MAX_LENGTH = {
     'label': 50,
-    'name': 50,
   }
 
   TYPES = (
@@ -320,6 +384,7 @@ class CustomField(CreatedAtMixin, UpdatedAtMixin, CTCTEndpointModel):
   # API editable fields
   label = models.CharField(
     max_length=API_MAX_LENGTH['label'],
+    unique=True,
     verbose_name=_('Label'),
     help_text=_(
       'The display name for the custom_field shown in the UI as free-form text'
@@ -466,6 +531,10 @@ class Contact(CreatedAtMixin, UpdatedAtMixin, CTCTEndpointModel):
     verbose_name=_('List Memberships'),
     blank=True,
   )
+  custom_field_set = models.ManyToManyField(
+    CustomField,
+    through=ContactCustomField,  # c.f. django-stubs GH PR #1719
+  )
 
   permission_to_send = models.CharField(
     max_length=20,
@@ -676,16 +745,16 @@ class ContactPhoneNumber(CreatedAtMixin, UpdatedAtMixin, CTCTModel):
     verbose_name = _('Phone Number')
     verbose_name_plural = _('Phone Numbers')
 
-    # constraints = [
-    #    models.UniqueConstraint(  # TODO: GH #7
-    #      fields=['contact', 'kind'],
-    #      name='django_ctct_unique_phone_number',
-    #    ),
-    #    models.CheckConstraint(   # TODO: GH #8
-    #      check=Q(contact__phone_numbers__count__lte=ContactRemoteManager.API_MAX_NUM['phone_numbers'])
-    #      name='django_ctct_limit_phone_numbers',
-    #    ),
-    # ]
+    constraints = [
+       models.UniqueConstraint(
+         fields=['contact', 'kind'],
+         name='django_ctct_unique_phone_number',
+       ),
+       # models.CheckConstraint(   # TODO: GH #8
+       #   check=Q(contact__phone_numbers__count__lte=ContactRemoteManager.API_MAX_NUM['phone_numbers'])
+       #   name='django_ctct_limit_phone_numbers',
+       # ),
+    ]
 
   def __str__(self) -> str:
     return f'[{self.get_kind_display()}] {self.phone_number}'
@@ -777,16 +846,16 @@ class ContactStreetAddress(CreatedAtMixin, UpdatedAtMixin, CTCTModel):
     verbose_name = _('Street Address')
     verbose_name_plural = _('Street Addresses')
 
-    # constraints = [
-    #    models.UniqueConstraint(  # TODO: GH #7
-    #      fields=['contact', 'kind'],
-    #      name='django_ctct_unique_street_address',
-    #    ),
-    #    models.CheckConstraint(   # TODO: GH #8
-    #      check=Q(contact__street_addresses__count__lte=ContactRemoteManager.API_MAX_NUM['street_addresses']),
-    #      name='django_ctct_limit_street_addresses',
-    #    ),
-    # ]
+    constraints = [
+       models.UniqueConstraint(
+         fields=['contact', 'kind'],
+         name='django_ctct_unique_street_address',
+       ),
+       # models.CheckConstraint(   # TODO: GH #8
+       #   check=Q(contact__street_addresses__count__lte=ContactRemoteManager.API_MAX_NUM['street_addresses']),
+       #   name='django_ctct_limit_street_addresses',
+       # ),
+    ]
 
   def __str__(self) -> str:
     field_names = ['street', 'city', 'state']
@@ -816,65 +885,6 @@ class ContactStreetAddress(CreatedAtMixin, UpdatedAtMixin, CTCTModel):
     return cls.clean_remote_string('country', data)
 
 
-# TODO: GH #14
-class ContactCustomField(models.Model):
-  """Django implementation of a CTCT Contact's CustomField.
-
-  Notes
-  -----
-  CTCT does not provide UUIDs for these, so we do not inherit from CTCTModel.
-
-  """
-
-  API_EDITABLE_FIELDS = (
-    'custom_field_id',
-    'value',
-  )
-  API_MAX_LENGTH = {
-    'value': 255,
-  }
-
-  contact = models.ForeignKey(
-    Contact,
-    on_delete=models.CASCADE,
-    related_name='custom_fields',
-    verbose_name=_('Contact'),
-  )
-  custom_field = models.ForeignKey(
-    CustomField,
-    on_delete=models.CASCADE,
-    related_name='contacts',
-    verbose_name=_('Field'),
-  )
-
-  value = models.CharField(
-    max_length=API_MAX_LENGTH['value'],
-    verbose_name=_('Value'),
-  )
-
-  class Meta:
-    verbose_name = _('Custom Field')
-    verbose_name_plural = _('Custom Fields')
-
-    # constraints = [
-    #    models.UniqueConstraint(  # TODO: GH #7
-    #      fields=['contact', 'custom_field'],
-    #      name='django_ctct_unique_custom_field',
-    #    ),
-    #    models.CheckConstraint(   # TODO: GH #8
-    #      check=Q(contact__custom_fields__count__lte=ContactRemoteManager.API_MAX_NUM['custom_fields']),
-    #      name='django_ctct_limit_custom_fields',
-    #    ),
-    # ]
-
-  def __str__(self) -> str:
-    try:
-      s = f'[{self.custom_field.label}] {self.value}'
-    except CustomField.DoesNotExist:
-      s = super().__str__()
-    return s
-
-
 class EmailCampaign(CreatedAtMixin, UpdatedAtMixin, CTCTEndpointModel):
   """Django implementation of a CTCT EmailCampaign."""
 
@@ -913,7 +923,7 @@ class EmailCampaign(CreatedAtMixin, UpdatedAtMixin, CTCTEndpointModel):
   # API editable fields
   name = models.CharField(
     max_length=API_MAX_LENGTH['name'],
-    # unique=True,  # TODO: GH #7
+    unique=True,
     verbose_name=_('Name'),
   )
   scheduled_datetime = models.DateTimeField(
@@ -1306,12 +1316,18 @@ class CampaignSummary(CTCTEndpointModel):
 
 
 def is_ctct(
-  val: Type[BaseModel] | Literal['self']
+  val: Type[BaseModel] | Literal['self'] | None
 ) -> TypeGuard[Type[CTCTModel]]:
   return isinstance(val, type) and issubclass(val, CTCTModel)
 
 
 def is_model(
-  val: Type[BaseModel] | Literal['self']
+  val: Type[BaseModel] | Literal['self'] | None
 ) -> TypeGuard[Type[Model]]:
   return isinstance(val, type) and issubclass(val, Model)
+
+
+def is_serial(
+   val: Type[BaseModel] | Literal['self'] | None
+) -> TypeGuard[Type[SerialModel]]:
+  return isinstance(val, type) and issubclass(val, SerialModel)

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev5}/django_ctct/utils.py

@@ -18,6 +18,9 @@ RelatedFields: TypeAlias = tuple[
 
 
 def to_dt(s: str, ts_format: str = '%Y-%m-%dT%H:%M:%SZ') -> dt.datetime:
+  if '.' in s:
+    # Remove milliseconds
+    s = s.split('.')[0] + 'Z'
   return timezone.make_aware(dt.datetime.strptime(s, ts_format))
 
 

{django_ctct-0.0.1.dev4 → django_ctct-0.0.1.dev5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-ctct"
-version = "0.0.1.dev4"
+version = "0.0.1.dev5"
 description = "A Django interface for the Constant Contact API"
 authors = [
     {name = "Geoffrey Eisenbarth",email = "geoffrey.eisenbarth@gmail.com"}
@@ -14,6 +14,7 @@ dependencies = [
     "ratelimit (>=2.2.1,<3.0.0)",
     "tqdm (>=4.67.1,<5.0.0)",
     "pyjwt[crypto] (>=2.10.1,<3.0.0)",
+    "mypy (>=1.19.0,<2.0.0)",
 ]