[ISSUE-3680] Sync ConnectWise configuration records

djconnectwise/__init__.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-VERSION = (1, 6, 3, 'final')
+VERSION = (1, 6, 4, 'final')
 
 # pragma: no cover
 if VERSION[-1] != "final":

djconnectwise/admin.py

@@ -473,3 +473,17 @@ class CompanyTeamAdmin(admin.ModelAdmin):
 @admin.register(models.CompanySite)
 class CompanySiteAdmin(admin.ModelAdmin):
     list_display = ('id', 'name', 'company', 'inactive')
+
+
+@admin.register(models.ConfigurationStatus)
+class ConfigurationStatusAdmin(admin.ModelAdmin):
+    list_display = ('id', 'description', 'closed_flag', 'default_flag')
+    list_filter = ('closed_flag', 'default_flag')
+    search_fields = ['description']
+
+
+@admin.register(models.ConfigurationType)
+class ConfigurationTypeAdmin(admin.ModelAdmin):
+    list_display = ('id', 'name', 'inactive_flag', 'system_flag')
+    list_filter = ('inactive_flag', 'system_flag')
+    search_fields = ['name']

djconnectwise/api.py

@@ -1422,6 +1422,40 @@ def get_project_notes_count(self, project_id):
         return len(res)
 
 
+class ConfigurationAPIClient(ConnectWiseAPIClient):
+    API = 'company'
+    ENDPOINT_CONFIGURATIONS = 'configurations/'
+    ENDPOINT_STATUS = '{}statuses/'.format(ENDPOINT_CONFIGURATIONS)
+    ENDPOINT_TYPES = '{}types/'.format(ENDPOINT_CONFIGURATIONS)
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def get_configurations(self, company_id, *args, **kwargs):
+        """
+        Retrieves configurations for a given company ID.
+        """
+        api_conditions = f'company/id={company_id}'
+        params = {'conditions': api_conditions}
+        return self.fetch_resource(self.ENDPOINT_CONFIGURATIONS,
+                                   params=params, should_page=True,
+                                   *args, **kwargs)
+
+    def get_configuration_statuses(self, *args, **kwargs):
+        """
+        Retrieves configuration statuses from the API.
+        """
+        return self.fetch_resource(self.ENDPOINT_STATUS, should_page=True,
+                                   *args, **kwargs)
+
+    def get_configuration_types(self, *args, **kwargs):
+        """
+        Retrieves configuration types from the API.
+        """
+        return self.fetch_resource(self.ENDPOINT_STATUS, should_page=True,
+                                   *args, **kwargs)
+
+
 class FinanceAPIClient(ConnectWiseAPIClient):
     API = 'finance'
     ENDPOINT_AGREEMENTS = 'agreements'

djconnectwise/management/commands/cwsync.py

@@ -117,6 +117,10 @@ def __init__(self, *args, **kwargs):
             ('activity_udf', sync.ActivityUDFSynchronizer, _('Activity UDF')),
             ('opportunity_udf', sync.OpportunityUDFSynchronizer,
              _('Opportunity UDF')),
+            ('configuration_status', sync.ConfigurationStatusSynchronizer,
+             _('Configuration Status')),
+            ('configuration_type', sync.ConfigurationTypeSynchronizer,
+             _('Configuration Type')),
         )
 
         settings = DjconnectwiseSettings().get_settings()

djconnectwise/migrations/0186_configurationstatus_configurationtype_and_more.py

@@ -0,0 +1,68 @@
+# Generated by Django 4.2.11 on 2024-09-09 16:15
+
+from django.db import migrations, models
+import django_extensions.db.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('djconnectwise', '0185_contact_type'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='ConfigurationStatus',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', django_extensions.db.fields.CreationDateTimeField(auto_now_add=True, verbose_name='created')),
+                ('modified', django_extensions.db.fields.ModificationDateTimeField(auto_now=True, verbose_name='modified')),
+                ('description', models.CharField(max_length=255)),
+                ('closed_flag', models.BooleanField(default=False)),
+                ('default_flag', models.BooleanField(default=False)),
+            ],
+            options={
+                'verbose_name_plural': 'Configuration Statuses',
+                'ordering': ['description'],
+            },
+        ),
+        migrations.CreateModel(
+            name='ConfigurationType',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', django_extensions.db.fields.CreationDateTimeField(auto_now_add=True, verbose_name='created')),
+                ('modified', django_extensions.db.fields.ModificationDateTimeField(auto_now=True, verbose_name='modified')),
+                ('name', models.TextField(max_length=250)),
+                ('inactive_flag', models.BooleanField(default=False)),
+                ('system_flag', models.BooleanField(default=False)),
+            ],
+            options={
+                'verbose_name_plural': 'Configuration Types',
+                'ordering': ['name'],
+            },
+        ),
+        migrations.CreateModel(
+            name='ConfigurationStatusTracker',
+            fields=[
+            ],
+            options={
+                'db_table': 'djconnectwise_configurationstatus',
+                'proxy': True,
+                'indexes': [],
+                'constraints': [],
+            },
+            bases=('djconnectwise.configurationstatus',),
+        ),
+        migrations.CreateModel(
+            name='ConfigurationTypeTracker',
+            fields=[
+            ],
+            options={
+                'db_table': 'djconnectwise_configurationtype',
+                'proxy': True,
+                'indexes': [],
+                'constraints': [],
+            },
+            bases=('djconnectwise.configurationtype',),
+        ),
+    ]

djconnectwise/models.py

@@ -1492,6 +1492,40 @@ def get_connectwise_url(self):
         )
 
 
+class ConfigurationStatus(TimeStampedModel):
+    description = models.CharField(max_length=255)
+    closed_flag = models.BooleanField(default=False)
+    default_flag = models.BooleanField(default=False)
+
+    class Meta:
+        ordering = ['description']
+        verbose_name_plural = 'Configuration Statuses'
+
+    def __str__(self):
+        return self.description
+
+    @property
+    def api_class(self):
+        return api.ConfigurationAPIClient
+
+
+class ConfigurationType(TimeStampedModel):
+    name = models.TextField(max_length=250)
+    inactive_flag = models.BooleanField(default=False)
+    system_flag = models.BooleanField(default=False)
+
+    class Meta:
+        ordering = ['name']
+        verbose_name_plural = 'Configuration Types'
+
+    def __str__(self):
+        return self.name
+
+    @property
+    def api_class(self):
+        return api.ConfigurationAPIClient
+
+
 class Ticket(UpdateConnectWiseMixin, TimeStampedModel):
     SCHEDULE_ENTRY_TYPE = "S"
 
@@ -2629,6 +2663,22 @@ class Meta:
         db_table = 'djconnectwise_opportunity'
 
 
+class ConfigurationStatusTracker(ConfigurationStatus):
+    tracker = FieldTracker()
+
+    class Meta:
+        proxy = True
+        db_table = 'djconnectwise_configurationstatus'
+
+
+class ConfigurationTypeTracker(ConfigurationType):
+    tracker = FieldTracker()
+
+    class Meta:
+        proxy = True
+        db_table = 'djconnectwise_configurationtype'
+
+
 class ServiceNoteTracker(ServiceNote):
     tracker = FieldTracker()
 

djconnectwise/sync.py

@@ -943,6 +943,76 @@ def client_call(self, opportunity_id, *args, **kwargs):
         return self.client.get_notes(opportunity_id, *args, **kwargs)
 
 
+class ConfigurationSynchronizer:
+    client_class = api.ConfigurationAPIClient
+
+    def __init__(self, *args, **kwargs):
+        self.api_conditions = []
+        self.client = self.client_class()
+        request_settings = DjconnectwiseSettings().get_settings()
+        self.batch_size = request_settings['batch_size']
+
+    def fetch_configurations(self, company_id):
+        """
+        Fetch configurations from a specific company.
+        """
+        return self.client.get_configurations(company_id)
+
+
+class ConfigurationStatusSynchronizer(Synchronizer):
+    client_class = api.ConfigurationAPIClient
+    model_class = models.ConfigurationStatusTracker
+
+    related_meta = {
+        'company': (models.Company, 'company'),
+    }
+
+    def _assign_field_data(self, instance, json_data):
+        """
+        Assigns the data from the API instance to the model instance.
+        """
+        instance.id = json_data.get('id')
+        instance.description = json_data.get('description', '')
+        instance.closed_flag = json_data.get('closedFlag', False)
+        instance.default_flag = json_data.get('defaultFlag', False)
+
+        self.set_relations(instance, json_data)
+        return instance
+
+    def get_page(self, *args, **kwargs):
+        """
+        Retrieves a page of configuration statuses from the API.
+        """
+        return self.client.get_configuration_statuses(*args, **kwargs)
+
+
+class ConfigurationTypeSynchronizer(Synchronizer):
+    client_class = api.ConfigurationAPIClient
+    model_class = models.ConfigurationTypeTracker
+
+    related_meta = {
+        'company': (models.Company, 'company'),
+    }
+
+    def _assign_field_data(self, instance, json_data):
+        """
+        Assigns the data from the API instance to the model instance.
+        """
+        instance.id = json_data.get('id')
+        instance.name = json_data.get('name')
+        instance.inactive_flag = json_data.get('inactiveFlag', False)
+        instance.system_flag = json_data.get('systemFlag', False)
+
+        self.set_relations(instance, json_data)
+        return instance
+
+    def get_page(self, *args, **kwargs):
+        """
+        Retrieves a page of configuration types from the API.
+        """
+        return self.client.get_configuration_types(*args, **kwargs)
+
+
 class BoardSynchronizer(Synchronizer):
     client_class = api.ServiceAPIClient
     model_class = models.ConnectWiseBoardTracker

djconnectwise/tests/fixture_utils.py

@@ -128,6 +128,20 @@ def init_project_types():
     return synchronizer.sync()
 
 
+def init_configuration_statuses():
+    mocks.configuration_api_get_configuration_statuses(
+        fixtures.API_CONFIGURATION_STATUS)
+    synchronizer = sync.ConfigurationStatusSynchronizer()
+    return synchronizer.sync()
+
+
+def init_configuration_types():
+    mocks.configuration_api_get_configuration_types(
+        fixtures.API_CONFIGURATION_TYPES)
+    synchronizer = sync.ConfigurationTypeSynchronizer()
+    return synchronizer.sync()
+
+
 def init_project_phases():
     mocks.projects_api_get_project_phases_call(
         fixtures.API_PROJECT_PHASE_LIST)

djconnectwise/tests/fixtures.py

@@ -607,6 +607,34 @@
 ]
 
 
+API_CONFIGURATION_TYPES = [
+    {
+        'id': 1,
+        'name': 'Network',
+        'inactiveFlag': False,
+        'systemFlag': False,
+        '_info': {
+            'lastUpdated': '2001-01-08T18:05:13Z',
+            'updatedBy': None
+        }
+    }
+]
+
+
+API_CONFIGURATION_STATUS = [
+    {
+        'id': 1,
+        'description': 'Testing Network',
+        'closedFlag': False,
+        'defaultFlag': False,
+        '_info': {
+            'lastUpdated': '2001-01-08T18:05:13Z',
+            'updatedBy': None
+        }
+    }
+]
+
+
 API_PROJECT = {
     'id': 5,
     '_info': {

djconnectwise/tests/mocks.py

@@ -93,6 +93,18 @@ def projects_api_get_project_types_call(return_value, raised=None):
     return create_mock_call(method_name, return_value, side_effect=raised)
 
 
+def configuration_api_get_configuration_statuses(return_value, raised=None):
+    method_name = \
+        'djconnectwise.api.ConfigurationAPIClient.get_configuration_statuses'
+    return create_mock_call(method_name, return_value, side_effect=raised)
+
+
+def configuration_api_get_configuration_types(return_value, raised=None):
+    method_name = \
+        'djconnectwise.api.ConfigurationAPIClient.get_configuration_types'
+    return create_mock_call(method_name, return_value, side_effect=raised)
+
+
 def projects_api_get_project_phases_call(return_value, raised=None):
     method_name = 'djconnectwise.api.ProjectAPIClient.get_project_phases'
     return create_mock_call(method_name, return_value, side_effect=raised)