fix(Brevo): Mieux gérer la mises à jour des contacts Brevo (et envoye…

…r le téléphone) (#1230)

lemarche/crm/management/commands/crm_brevo_sync_contacts.py

@@ -7,11 +7,12 @@
 
 class Command(BaseCommand):
     """
-    Command script to send Users to Brevo CRM and/or save their Brevo contact ID
+    Script to send Users to Brevo CRM and/or save their Brevo contact ID
 
     Usage:
+    python manage.py crm_brevo_sync_contacts --kind-users=BUYER --brevo-list-id=10 --with-existing-contacts --dry-run
+    python manage.py crm_brevo_sync_contacts --kind-users=SIAE --brevo-list-id=23
     python manage.py crm_brevo_sync_contacts --kind-users=SIAE --brevo-list-id=23
-    python manage.py crm_brevo_sync_contacts --kind-users=BUYER --brevo-list-id=10 --dry-run
     """
 
     def add_arguments(self, parser):
@@ -23,26 +24,25 @@ def add_arguments(self, parser):
             required=True,
             help="set brevo list id",
         )
-        parser.add_argument("--dry-run", dest="dry_run", action="store_true", help="Dry run (no changes to the DB)")
         parser.add_argument(
             "--with-existing-contacts",
             dest="with_existing_contacts",
-            type=bool,
-            default=True,
-            help="make it with existing contacts in brevo",
+            action="store_true",
+            help="Check existing contact in brevo list",
         )
+        parser.add_argument("--dry-run", dest="dry_run", action="store_true", help="Dry run (no changes to the DB)")
 
     def handle(self, dry_run: bool, kind_users: str, brevo_list_id: int, with_existing_contacts: bool, **options):
         self.stdout.write("-" * 80)
         self.stdout.write("Script to sync with Contact Brevo CRM...")
 
         users_qs = User.objects.filter(kind=kind_users)
 
-        self.stdout.write(f"User: find {users_qs.count()} users {kind_users}.")
+        self.stdout.write(f"Sync User > Brevo: found {users_qs.count()} users {kind_users}.")
         existing_contacts = None
         if with_existing_contacts:
             existing_contacts = api_brevo.get_all_users_from_list(list_id=brevo_list_id)
-            self.stdout.write(f"Contacts in brevo list: find {len(existing_contacts)} contacts.")
+            self.stdout.write(f"Contacts in brevo list: found {len(existing_contacts)} contacts.")
 
         if not dry_run:
             for index, user in enumerate(users_qs):
@@ -64,8 +64,8 @@ def handle(self, dry_run: bool, kind_users: str, brevo_list_id: int, with_existi
                     user.save(update_fields=["brevo_contact_id"])
                 # we still don't have a contact id, add to brevo
                 else:
-                    self.stdout.write(f"Create and save contact {user.email} in Brevo.")
-                    api_brevo.create_contact(user=user, list_id=brevo_list_id, with_user_save=True)
+                    self.stdout.write(f"Create (or update) and save contact {user.email} in Brevo.")
+                    api_brevo.create_contact(user=user, list_id=brevo_list_id)
 
                 if (index % 10) == 0:  # avoid API rate-limiting
                     time.sleep(1)

lemarche/utils/apis/api_brevo.py

@@ -28,7 +28,12 @@ def get_api_client():
     return sib_api_v3_sdk.ApiClient(config)
 
 
-def create_contact(user, list_id: int, with_user_save=True):
+def create_contact(user, list_id: int):
+    """
+    Brevo docs
+    - Python library: https://github.com/sendinblue/APIv3-python-library/blob/master/docs/CreateContact.md
+    - API: https://developers.brevo.com/reference/createcontact
+    """
     api_client = get_api_client()
     api_instance = sib_api_v3_sdk.ContactsApi(api_client)
     new_contact = sib_api_v3_sdk.CreateContact(
@@ -40,14 +45,16 @@ def create_contact(user, list_id: int, with_user_save=True):
             "DATE_INSCRIPTION": user.created_at,
             "TYPE_ORGANISATION": user.buyer_kind_detail,
             "NOM_ENTREPRISE": user.company_name,
+            "SMS": user.phone_display,
+            # WHATSAPP, TYPE_ORGANISATION, LIEN_FICHE_COMMERCIALE, TAUX_DE_COMPLETION
         },
         ext_id=str(user.id),
         update_enabled=True,
     )
 
     try:
         api_response = api_instance.create_contact(new_contact).to_dict()
-        if with_user_save:
+        if not user.brevo_contact_id:
             user.brevo_contact_id = api_response.get("id")
             user.save()
         logger.info(f"Success Brevo->ContactsApi->create_contact: {api_response}")
@@ -73,9 +80,9 @@ def remove_contact_from_list(user, list_id: int):
 
 def create_or_update_company(siae):
     """
-    Brevo docs:
+    Brevo docs
     - Python library: https://github.com/sendinblue/APIv3-python-library/blob/master/docs/CompaniesApi.md
-    - API: https://developers.brevo.com/reference/get_companies
+    - API: https://developers.brevo.com/reference/post_companies
     """
     api_client = get_api_client()
     api_instance = sib_api_v3_sdk.CompaniesApi(api_client)
@@ -122,47 +129,17 @@ def create_or_update_company(siae):
             logger.error(f"Exception when calling Brevo->CompaniesApi->create_or_update_company (create): {e}")
 
 
-@task()
-def send_transactional_email_with_template(
-    template_id: int,
-    recipient_email: str,
-    recipient_name: str,
-    variables: dict,
-    subject=None,
-    from_email=settings.DEFAULT_FROM_EMAIL,
-    from_name=settings.DEFAULT_FROM_NAME,
-):
-    api_client = get_api_client()
-    api_instance = sib_api_v3_sdk.TransactionalEmailsApi(api_client)
-    data = {
-        "sender": {"email": from_email, "name": from_name},
-        "to": [{"email": recipient_email, "name": recipient_name}],
-        "template_id": template_id,
-        "params": variables,
-    }
-    # if subject empty, defaults to Brevo's template subject
-    if subject:
-        data["subject"] = EMAIL_SUBJECT_PREFIX + subject
-
-    if settings.BITOUBI_ENV not in ENV_NOT_ALLOWED:
-        try:
-            send_smtp_email = sib_api_v3_sdk.SendSmtpEmail(**data)
-            response = api_instance.send_transac_email(send_smtp_email)
-            logger.info("Brevo: send transactional email with template")
-            return response
-        except ApiException as e:
-            print(f"Exception when calling SMTPApi->send_transac_email: {e}")
-    else:
-        logger.info("Brevo: email not sent (DEV or TEST environment detected)")
-
-
 def create_deal(tender, owner_email: str):
     """
     Creates a new deal in Brevo CRM from a tender and logs the result.
 
     This function configures a deal using the tender's details and the owner's email, and posts it to the Brevo CRM.
     If successful, it updates the tender with the new deal ID. If it encounters issues, it logs an error.
 
+    Brevo docs
+    - https://github.com/sendinblue/APIv3-python-library/blob/master/docs/DealsApi.md
+    - https://developers.brevo.com/reference/post_crm-deals
+
     Args:
         tender (Tender): Object with tender details like title, description, amount, and deadlines.
         owner_email (str): The email address of the deal's owner.
@@ -175,13 +152,14 @@ def create_deal(tender, owner_email: str):
     body_deal = sib_api_v3_sdk.Body3(
         name=tender.title,
         attributes={
+            # default attributes
+            # pipeline, deal_stage, closed_won_reason, closed_lost_reason, total_revenue, lost_reason
             "deal_description": tender.description,
-            # "deal_pipeline": "...",
-            # "deal_stage": "...",
             "deal_owner": owner_email,
+            "close_date": tender.deadline_date.strftime("%Y-%m-%d"),
+            # custom attributes
             "amount": AMOUNT_RANGE_CHOICE_EXACT.get(tender.amount, 0),
             "tender_admin_url": tender.get_admin_url(),
-            "close_date": tender.deadline_date.strftime("%Y-%m-%d"),
         },
     )
 
@@ -325,3 +303,37 @@ def get_all_users_from_list(
             logger.error(f"Unexpected error: {e}")
             break
     return result
+
+
+@task()
+def send_transactional_email_with_template(
+    template_id: int,
+    recipient_email: str,
+    recipient_name: str,
+    variables: dict,
+    subject=None,
+    from_email=settings.DEFAULT_FROM_EMAIL,
+    from_name=settings.DEFAULT_FROM_NAME,
+):
+    api_client = get_api_client()
+    api_instance = sib_api_v3_sdk.TransactionalEmailsApi(api_client)
+    data = {
+        "sender": {"email": from_email, "name": from_name},
+        "to": [{"email": recipient_email, "name": recipient_name}],
+        "template_id": template_id,
+        "params": variables,
+    }
+    # if subject empty, defaults to Brevo's template subject
+    if subject:
+        data["subject"] = EMAIL_SUBJECT_PREFIX + subject
+
+    if settings.BITOUBI_ENV not in ENV_NOT_ALLOWED:
+        try:
+            send_smtp_email = sib_api_v3_sdk.SendSmtpEmail(**data)
+            response = api_instance.send_transac_email(send_smtp_email)
+            logger.info("Brevo: send transactional email with template")
+            return response
+        except ApiException as e:
+            print(f"Exception when calling SMTPApi->send_transac_email: {e}")
+    else:
+        logger.info("Brevo: email not sent (DEV or TEST environment detected)")