feat: List conversations for self serve messaging

config/backend-routes/messaging/messaging.php

@@ -19,6 +19,12 @@
                             'GET' => QueryConfig::getConfig(Query\Messaging\Conversations\ByLicence::class),
                         ],
                     ),
+                    'by-organisation' => RouteConfig::getRouteConfig(
+                        'by-organisation',
+                        [
+                            'GET' => QueryConfig::getConfig(Query\Messaging\Conversations\ByOrganisation::class),
+                        ],
+                    ),
                     'by-application-to-licence' => RouteConfig::getRouteConfig(
                         'by-application-to-licence',
                         [

src/Query/Messaging/Conversations/ByOrganisation.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dvsa\Olcs\Transfer\Query\Messaging\Conversations;
+
+use Dvsa\Olcs\Transfer\FieldType\Traits\Organisation;
+use Dvsa\Olcs\Transfer\Query\AbstractQuery;
+use Dvsa\Olcs\Transfer\Query\PagedQueryInterface;
+use Dvsa\Olcs\Transfer\Query\PagedTrait;
+use Dvsa\Olcs\Transfer\Util\Annotation as Transfer;
+
+/**
+ * @Transfer\RouteName("backend/messaging/conversations/by-organisation")
+ */
+final class ByOrganisation extends AbstractQuery implements PagedQueryInterface
+{
+    use PagedTrait;
+    use Organisation;
+}

test/Query/Messaging/Conversations/ByOrganisationTest.php

@@ -0,0 +1,114 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dvsa\OlcsTest\Transfer\Query\Messaging\Conversations;
+
+use Dvsa\Olcs\Transfer\Query\Messaging\Conversations\ByOrganisation;
+use Dvsa\OlcsTest\Transfer\DtoWithoutOptionalFieldsTest;
+use Dvsa\OlcsTest\Transfer\Query\QueryTest;
+use Laminas\Stdlib\ArraySerializableInterface;
+
+class ByOrganisationTest extends \PHPUnit\Framework\TestCase
+{
+    use QueryTest, DtoWithoutOptionalFieldsTest {
+        DtoWithoutOptionalFieldsTest::testDefaultValues insteadof QueryTest;
+    }
+
+    /**
+     * Should return a new blank DTO on which to run tests
+     *
+     * @return ArraySerializableInterface
+     */
+    protected function createBlankDto()
+    {
+        return new ByOrganisation();
+    }
+
+    /**
+     * Should return an array of valid field values (i.e. those which should pass validation)
+     *
+     * for example:
+     *
+     * return [
+     *     'fieldName' => [
+     *         'good-value-1',
+     *         'good-value-2',
+     *     ],
+     *     'anotherFieldName' => ['good-value'],
+     * ];
+     *
+     * @return array
+     */
+    protected function getValidFieldValues()
+    {
+        return [
+            'organisation' => [
+                '1',
+            ],
+            'page' => [
+                '1',
+            ],
+            'limit' => [
+                '1',
+            ],
+        ];
+    }
+
+    /**
+     * Should return an array of invalid field values (i.e. those which should fail validation)
+     *
+     * for example:
+     *
+     * return [
+     *     'fieldName' => [
+     *         'bad-value-1',
+     *         'bad-value-2',
+     *     ],
+     *     'anotherFieldName' => ['bad-value'],
+     * ];
+     *
+     * @return array
+     */
+    protected function getInvalidFieldValues()
+    {
+        $invalidNumbers = [0,
+            'a',
+            '-',
+            '\n',];
+
+        return [
+            'organisation' => $invalidNumbers,
+            'page' => $invalidNumbers,
+            'limit' => $invalidNumbers,
+        ];
+    }
+
+    /**
+     * Should return an array of expected transformations which input filters should apply to fields
+     *
+     * for example:
+     *
+     * return [
+     *     'fieldWhichGetsTrimmed' => [[' string ', 'string']],
+     *     'fieldWhichFiltersOutNonNumericDigits => [
+     *         ['a1b2c3', '123'],
+     *         [99, '99'],
+     *     ],
+     * ];
+     *
+     * Tests expect the function 'getFoo' to exist for the function 'foo'.
+     *
+     * This DOES NOT assert that the value gets validated. To do that @see DtoTest::getValidFieldValues
+     *
+     * @return array
+     */
+    protected function getFilterTransformations()
+    {
+        return [
+            'ids' => [[99, '99']],
+            'page' => [[99, '99']],
+            'limit' => [[99, '99']],
+        ];
+    }
+}