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.partner
21 
22 import io.circe.Decoder
23 import io.circe.generic.semiauto.deriveDecoder
24 import io.swagger.annotations.ApiModelProperty
25 import org.make.core.technical.Pagination
26 import org.make.core.partner.{Partner, PartnerId, PartnerKind}
27 import org.make.core.question.QuestionId
28 import org.make.core.user.UserId
29 import org.make.core.Order
30 
31 import scala.concurrent.Future
32 
33 import scala.annotation.meta.field
34 
35 trait PartnerServiceComponent {
36   def partnerService: PartnerService
37 }
38 
39 trait PartnerService {
40   def getPartner(partnerId: PartnerId): Future[Option[Partner]]
41   def find(
42     offset: Pagination.Offset,
43     end: Option[Pagination.End],
44     sort: Option[String],
45     order: Option[Order],
46     questionId: Option[QuestionId],
47     organisationId: Option[UserId],
48     partnerKind: Option[PartnerKind]
49   ): Future[Seq[Partner]]
50   def count(
51     questionId: Option[QuestionId],
52     organisationId: Option[UserId],
53     partnerKind: Option[PartnerKind]
54   ): Future[Int]
55   def createPartner(request: CreatePartnerRequest): Future[Partner]
56   def updatePartner(partnerId: PartnerId, request: UpdatePartnerRequest): Future[Option[Partner]]
57   def deletePartner(partnerId: PartnerId): Future[Unit]
58 }
59 
60 final case class CreatePartnerRequest(
61   name: String,
62   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/logo.png")
63   logo: Option[String],
64   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/link")
65   link: Option[String],
66   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
67   organisationId: Option[UserId],
68   @(ApiModelProperty @field)(dataType = "string", allowableValues = PartnerKind.swaggerAllowableValues)
69   partnerKind: PartnerKind,
70   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
71   questionId: QuestionId,
72   weight: Float
73 )
74 
75 object CreatePartnerRequest {
76   implicit val decoder: Decoder[CreatePartnerRequest] = deriveDecoder[CreatePartnerRequest]
77 }
78 
79 final case class UpdatePartnerRequest(
80   name: String,
81   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/logo.png")
82   logo: Option[String],
83   @(ApiModelProperty @field)(dataType = "string", example = "https://example.com/link")
84   link: Option[String],
85   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555")
86   organisationId: Option[UserId],
87   @(ApiModelProperty @field)(dataType = "string", allowableValues = PartnerKind.swaggerAllowableValues)
88   partnerKind: PartnerKind,
89   weight: Float
90 )
91 
92 object UpdatePartnerRequest {
93   implicit val decoder: Decoder[UpdatePartnerRequest] = deriveDecoder[UpdatePartnerRequest]
94 }