From 932ea7da0685e31b73696edce9823d351ba77658 Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <emcnaughton@wikimedia.org>
Date: Wed, 26 Jan 2022 13:32:05 +1300
Subject: [PATCH] dev/core#2486 Add v4 Mailing api (+ MailingJob)

ro
---
 Civi/Api4/Mailing.php                | 25 ++++++++++++++++++++++++
 Civi/Api4/MailingJob.php             | 29 ++++++++++++++++++++++++++++
 tests/phpunit/api/v3/MailingTest.php | 21 ++++++++++++++------
 3 files changed, 69 insertions(+), 6 deletions(-)
 create mode 100644 Civi/Api4/Mailing.php
 create mode 100644 Civi/Api4/MailingJob.php

diff --git a/Civi/Api4/Mailing.php b/Civi/Api4/Mailing.php
new file mode 100644
index 0000000000..e9ada0ac81
--- /dev/null
+++ b/Civi/Api4/Mailing.php
@@ -0,0 +1,25 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+namespace Civi\Api4;
+
+/**
+ * Mailing.
+ *
+ * Mailing entities store the contents and settings for bulk mails.
+ *
+ * @searchable secondary
+ * @see https://docs.civicrm.org/user/en/latest/email/what-is-civimail/
+ * @since 5.47
+ * @package Civi\Api4
+ */
+class Mailing extends Generic\DAOEntity {
+
+}
diff --git a/Civi/Api4/MailingJob.php b/Civi/Api4/MailingJob.php
new file mode 100644
index 0000000000..56b43d88e0
--- /dev/null
+++ b/Civi/Api4/MailingJob.php
@@ -0,0 +1,29 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+namespace Civi\Api4;
+
+use Civi\Api4\Generic\Traits\ReadOnlyEntity;
+
+/**
+ * Mailing job.
+ *
+ * Mailing job tracks the batching of CiviMails.
+ *
+ * @searchable none
+ *
+ * @see https://docs.civicrm.org/user/en/latest/email/what-is-civimail/
+ * @since 5.47
+ * @package Civi\Api4
+ */
+class MailingJob extends Generic\DAOEntity {
+  use ReadOnlyEntity;
+
+}
diff --git a/tests/phpunit/api/v3/MailingTest.php b/tests/phpunit/api/v3/MailingTest.php
index 2a99e70f9d..667bfefce8 100644
--- a/tests/phpunit/api/v3/MailingTest.php
+++ b/tests/phpunit/api/v3/MailingTest.php
@@ -77,15 +77,21 @@ class api_v3_MailingTest extends CiviUnitTestCase {
 
   /**
    * Test civicrm_mailing_create.
+   *
+   * @dataProvider versionThreeAndFour
+   *
+   * @param int $version
    */
-  public function testMailerCreateSuccess(): void {
+  public function testMailerCreateSuccess(int $version): void {
+    $this->_apiversion = $version;
+    $this->enableCiviCampaign();
     $this->callAPISuccess('Campaign', 'create', ['name' => 'big campaign', 'title' => 'abc']);
     $result = $this->callAPIAndDocument('mailing', 'create', $this->_params + ['scheduled_date' => 'now', 'campaign_id' => 'big campaign'], __FUNCTION__, __FILE__);
-    $jobs = $this->callAPISuccess('mailing_job', 'get', ['mailing_id' => $result['id']]);
+    $jobs = $this->callAPISuccess('MailingJob', 'get', ['mailing_id' => $result['id']]);
     $this->assertEquals(1, $jobs['count']);
     // return isn't working on this in getAndCheck so lets not check it for now
     unset($this->_params['created_id']);
-    $this->getAndCheck($this->_params, $result['id'], 'mailing');
+    $this->getAndCheck($this->_params, $result['id'], 'Mailing');
   }
 
   /**
@@ -103,9 +109,12 @@ class api_v3_MailingTest extends CiviUnitTestCase {
   /**
    * Create a completed mailing (e.g when importing from a provider).
    *
-   * @throws \CRM_Core_Exception
+   * @dataProvider versionThreeAndFour
+   *
+   * @param int $version
    */
-  public function testMailerCreateCompleted() {
+  public function testMailerCreateCompleted(int $version): void {
+    $this->_apiversion = $version;
     $this->_params['body_html'] = 'I am completed so it does not matter if there is an opt out link since I have already been sent by another system';
     $this->_params['is_completed'] = 1;
     $result = $this->callAPIAndDocument('mailing', 'create', $this->_params + ['scheduled_date' => 'now'], __FUNCTION__, __FILE__);
@@ -120,7 +129,7 @@ class api_v3_MailingTest extends CiviUnitTestCase {
   /**
    * Per CRM-20316 the mailing should still create without created_id (not mandatory).
    */
-  public function testMailerCreateSuccessNoCreatedID() {
+  public function testMailerCreateSuccessNoCreatedID(): void {
     unset($this->_params['created_id']);
     $result = $this->callAPIAndDocument('mailing', 'create', $this->_params + ['scheduled_date' => 'now'], __FUNCTION__, __FILE__);
     $this->getAndCheck($this->_params, $result['id'], 'mailing');
-- 
2.25.1