api-spec/CampaignApi.java at main · RahulABangar07/api-spec · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
package com.example.campaign.api;

import com.example.campaign.dto.*;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.web.bind.annotation.*;

import java.time.OffsetDateTime;
import java.util.List;

@RequestMapping("/campaigns")
public interface CampaignApi {

    /**
     * Create a new campaign.
     */
    @PostMapping("/create")
    @ResponseBody
    CreateCampaignResponse createCampaign(@RequestBody CreateCampaignRequest request);

    /**
     * Get campaigns based on optional published and expiration dates.
     */
    @GetMapping
    @ResponseBody
    List<Campaign> getCampaigns(
        @RequestParam(required = false)
        @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
        OffsetDateTime publishedDate,

        @RequestParam(required = false)
        @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
        OffsetDateTime expirationDate,

        @RequestHeader("Authorization") String authorization,
        @RequestHeader("Product") String product
    );

    /**
     * Submit a campaign.
     */
    @PostMapping("/submit")
    @ResponseBody
    SubmittedCampaign submitCampaign(
        @RequestParam(required = false)
        @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
        OffsetDateTime publishedDate,

        @RequestParam(required = false)
        @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
        OffsetDateTime expirationDate,

        @RequestHeader("Authorization") String authorization,
        @RequestHeader("Product") String product
    );

    /**
     * Review a campaign.
     */
    @PostMapping("/review")
    @ResponseBody
    ReviewedCampaign reviewCampaign(
        @RequestBody ReviewCampaignRequest request,
        @RequestHeader("Authorization") String authorization,
        @RequestHeader("Product") String product
    );
}