1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2018 Make.org
4  *
5  * This program is free software: you can redistribute it and/or modify
6  *  it under the terms of the GNU Affero General Public License as
7  *  published by the Free Software Foundation, either version 3 of the
8  *  License, or (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU Affero General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Affero General Public License
16  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
17  *
18  */
19 
20 package org.make.api.technical.crm
21 
22 import java.nio.file.{Path, Paths}
23 import akka.Done
24 import enumeratum.values.{StringEnum, StringEnumEntry}
25 import io.circe.Decoder
26 import org.make.api.technical.crm.ManageContactAction.{AddNoForce, Remove}
27 import org.make.api.technical.job.JobActor.Protocol.Response.JobAcceptance
28 import org.make.core.Order
29 import org.make.core.technical.Pagination
30 
31 import scala.concurrent.Future
32 
33 trait CrmService {
34   def sendEmail(messages: SendMessages): Future[SendEmailResponse]
35   def synchronizeList(formattedDate: String, list: CrmList, csvDirectory: Path): Future[Done]
36   def createCrmUsers(): Future[Unit]
37   def anonymize(): Future[Unit]
38   def synchronizeContactsWithCrm(): Future[JobAcceptance]
39   def getUsersMailFromList(
40     listId: Option[String] = None,
41     sort: Option[String] = None,
42     order: Option[Order] = None,
43     countOnly: Option[Boolean] = None,
44     limit: Pagination.Limit,
45     offset: Pagination.Offset = Pagination.Offset(0)
46   ): Future[GetUsersMail]
47   def deleteRecipient(email: String): Future[Unit]
48 }
49 
50 trait CrmServiceComponent {
51   def crmService: CrmService
52 }
53 
54 final case class GetUsersMail(count: Int, total: Int, data: Seq[ContactMail])
55 object GetUsersMail {
56   implicit val decoder: Decoder[GetUsersMail] = Decoder.forProduct3("Count", "Total", "Data")(GetUsersMail.apply)
57 }
58 
59 final case class ContactMail(email: String, contactId: Long)
60 object ContactMail {
61   implicit val decoder: Decoder[ContactMail] = Decoder.forProduct2("Email", "ID")(ContactMail.apply)
62 }
63 
64 sealed abstract class CrmList(val value: String) extends StringEnumEntry {
65   def hardBounced: Boolean
66   def unsubscribed: Option[Boolean]
67 
68   def targetDirectory(csvDirectory: String): Path = {
69     Paths.get(csvDirectory, value)
70   }
71 
72   def actionOnHardBounce: ManageContactAction
73   def actionOnOptIn: ManageContactAction
74   def actionOnOptOut: ManageContactAction
75 }
76 
77 object CrmList extends StringEnum[CrmList] {
78   case object HardBounce extends CrmList("hardBounce") {
79     override val hardBounced: Boolean = true
80     override val unsubscribed: Option[Boolean] = None
81 
82     override val actionOnHardBounce: ManageContactAction = AddNoForce
83     override val actionOnOptIn: ManageContactAction = Remove
84     override val actionOnOptOut: ManageContactAction = Remove
85   }
86 
87   case object OptIn extends CrmList("optIn") {
88     override val hardBounced: Boolean = false
89     override val unsubscribed: Option[Boolean] = Some(false)
90 
91     override val actionOnHardBounce: ManageContactAction = Remove
92     override val actionOnOptIn: ManageContactAction = AddNoForce
93     override val actionOnOptOut: ManageContactAction = Remove
94   }
95 
96   case object OptOut extends CrmList("optOut") {
97     override val hardBounced: Boolean = false
98     override val unsubscribed: Option[Boolean] = Some(true)
99 
100     override val actionOnHardBounce: ManageContactAction = Remove
101     override val actionOnOptIn: ManageContactAction = Remove
102     override val actionOnOptOut: ManageContactAction = AddNoForce
103   }
104 
105   override val values: IndexedSeq[CrmList] = findValues
106   final val swaggerAllowableValues = "hardBounce,optIn,optOut"
107 }