• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

Adyen / adyen-java-api-library / #2700

16 Oct 2023 09:08AM UTC coverage: 12.744%. First build
#2700

push

web-flow
Merge 5a09e72da into b9e6d393c

744 of 744 new or added lines in 20 files covered. (100.0%)

11251 of 88288 relevant lines covered (12.74%)

0.13 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

91.67
/src/main/java/com/adyen/service/DisputesApi.java
1
/*
2
 * Disputes API
3
 * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes.  ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example:  ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).  ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.  For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ```
4
 *
5
 * The version of the OpenAPI document: 30
6
 * 
7
 *
8
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
 * https://openapi-generator.tech
10
 * Do not edit the class manually.
11
 */
12

13
package com.adyen.service;
14

15
import com.adyen.Client;
16
import com.adyen.Service;
17
import com.adyen.constants.ApiConstants;
18
import com.adyen.model.disputes.AcceptDisputeRequest;
19
import com.adyen.model.disputes.AcceptDisputeResponse;
20
import com.adyen.model.disputes.DefendDisputeRequest;
21
import com.adyen.model.disputes.DefendDisputeResponse;
22
import com.adyen.model.disputes.DefenseReasonsRequest;
23
import com.adyen.model.disputes.DefenseReasonsResponse;
24
import com.adyen.model.disputes.DeleteDefenseDocumentRequest;
25
import com.adyen.model.disputes.DeleteDefenseDocumentResponse;
26
import com.adyen.model.disputes.DownloadDefenseDocumentRequest;
27
import com.adyen.model.disputes.DownloadDefenseDocumentResponse;
28
import com.adyen.model.disputes.ServiceError;
29
import com.adyen.model.disputes.SupplyDefenseDocumentRequest;
30
import com.adyen.model.disputes.SupplyDefenseDocumentResponse;
31
import com.adyen.model.RequestOptions;
32
import com.adyen.service.exception.ApiException;
33
import com.adyen.service.resource.Resource;
34

35
import java.io.IOException;
36
import java.util.HashMap;
37
import java.util.Map;
38

39
public class DisputesApi extends Service {
40

41
    public static final String API_VERSION = "30";
42

43
    protected String baseURL;
44

45
    /**
46
    * General constructor in {@link com.adyen.service package}.
47
    * @param client {@link Client }  (required)
48
    */
49
    public DisputesApi(Client client) {
50
        super(client);
1✔
51
        this.baseURL = createBaseURL("https://ca-test.adyen.com/ca/services/DisputeService/v30");
1✔
52
    }
1✔
53

54
    /**
55
    * General constructor in {@link com.adyen.service package}.
56
    * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
57
    * @param client {@link Client }  (required)
58
    * @param baseURL {@link String }  (required)
59
    */
60
    public DisputesApi(Client client, String baseURL) {
61
        super(client);
×
62
        this.baseURL = baseURL;
×
63
    }
×
64

65
    /**
66
    * Accept a dispute
67
    *
68
    * @param acceptDisputeRequest {@link AcceptDisputeRequest }  (required)
69
    * @return {@link AcceptDisputeResponse }
70
    * @throws ApiException if fails to make API call
71
    */
72
    public AcceptDisputeResponse acceptDispute(AcceptDisputeRequest acceptDisputeRequest) throws ApiException, IOException {
73
        return acceptDispute(acceptDisputeRequest, null);
1✔
74
    }
75

76
    /**
77
    * Accept a dispute
78
    *
79
    * @param acceptDisputeRequest {@link AcceptDisputeRequest }  (required)
80
    * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional)
81
    * @return {@link AcceptDisputeResponse }
82
    * @throws ApiException if fails to make API call
83
    */
84
    public AcceptDisputeResponse acceptDispute(AcceptDisputeRequest acceptDisputeRequest, RequestOptions requestOptions) throws ApiException, IOException {
85

86
        String requestBody = acceptDisputeRequest.toJson();
1✔
87
        Resource resource = new Resource(this, this.baseURL + "/acceptDispute", null);
1✔
88
        String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null);
1✔
89
        return AcceptDisputeResponse.fromJson(jsonResult);
1✔
90
    }
91

92
    /**
93
    * Defend a dispute
94
    *
95
    * @param defendDisputeRequest {@link DefendDisputeRequest }  (required)
96
    * @return {@link DefendDisputeResponse }
97
    * @throws ApiException if fails to make API call
98
    */
99
    public DefendDisputeResponse defendDispute(DefendDisputeRequest defendDisputeRequest) throws ApiException, IOException {
100
        return defendDispute(defendDisputeRequest, null);
1✔
101
    }
102

103
    /**
104
    * Defend a dispute
105
    *
106
    * @param defendDisputeRequest {@link DefendDisputeRequest }  (required)
107
    * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional)
108
    * @return {@link DefendDisputeResponse }
109
    * @throws ApiException if fails to make API call
110
    */
111
    public DefendDisputeResponse defendDispute(DefendDisputeRequest defendDisputeRequest, RequestOptions requestOptions) throws ApiException, IOException {
112

113
        String requestBody = defendDisputeRequest.toJson();
1✔
114
        Resource resource = new Resource(this, this.baseURL + "/defendDispute", null);
1✔
115
        String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null);
1✔
116
        return DefendDisputeResponse.fromJson(jsonResult);
1✔
117
    }
118

119
    /**
120
    * Delete a defense document
121
    *
122
    * @param deleteDefenseDocumentRequest {@link DeleteDefenseDocumentRequest }  (required)
123
    * @return {@link DeleteDefenseDocumentResponse }
124
    * @throws ApiException if fails to make API call
125
    */
126
    public DeleteDefenseDocumentResponse deleteDisputeDefenseDocument(DeleteDefenseDocumentRequest deleteDefenseDocumentRequest) throws ApiException, IOException {
127
        return deleteDisputeDefenseDocument(deleteDefenseDocumentRequest, null);
1✔
128
    }
129

130
    /**
131
    * Delete a defense document
132
    *
133
    * @param deleteDefenseDocumentRequest {@link DeleteDefenseDocumentRequest }  (required)
134
    * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional)
135
    * @return {@link DeleteDefenseDocumentResponse }
136
    * @throws ApiException if fails to make API call
137
    */
138
    public DeleteDefenseDocumentResponse deleteDisputeDefenseDocument(DeleteDefenseDocumentRequest deleteDefenseDocumentRequest, RequestOptions requestOptions) throws ApiException, IOException {
139

140
        String requestBody = deleteDefenseDocumentRequest.toJson();
1✔
141
        Resource resource = new Resource(this, this.baseURL + "/deleteDisputeDefenseDocument", null);
1✔
142
        String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null);
1✔
143
        return DeleteDefenseDocumentResponse.fromJson(jsonResult);
1✔
144
    }
145

146
    /**
147
    * Download a defense document
148
    *
149
    * @param downloadDefenseDocumentRequest {@link DownloadDefenseDocumentRequest }  (required)
150
    * @return {@link DownloadDefenseDocumentResponse }
151
    * @throws ApiException if fails to make API call
152
    */
153
    public DownloadDefenseDocumentResponse downloadDisputeDefenseDocument(DownloadDefenseDocumentRequest downloadDefenseDocumentRequest) throws ApiException, IOException {
154
        return downloadDisputeDefenseDocument(downloadDefenseDocumentRequest, null);
1✔
155
    }
156

157
    /**
158
    * Download a defense document
159
    *
160
    * @param downloadDefenseDocumentRequest {@link DownloadDefenseDocumentRequest }  (required)
161
    * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional)
162
    * @return {@link DownloadDefenseDocumentResponse }
163
    * @throws ApiException if fails to make API call
164
    */
165
    public DownloadDefenseDocumentResponse downloadDisputeDefenseDocument(DownloadDefenseDocumentRequest downloadDefenseDocumentRequest, RequestOptions requestOptions) throws ApiException, IOException {
166

167
        String requestBody = downloadDefenseDocumentRequest.toJson();
1✔
168
        Resource resource = new Resource(this, this.baseURL + "/downloadDisputeDefenseDocument", null);
1✔
169
        String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null);
1✔
170
        return DownloadDefenseDocumentResponse.fromJson(jsonResult);
1✔
171
    }
172

173
    /**
174
    * Get applicable defense reasons
175
    *
176
    * @param defenseReasonsRequest {@link DefenseReasonsRequest }  (required)
177
    * @return {@link DefenseReasonsResponse }
178
    * @throws ApiException if fails to make API call
179
    */
180
    public DefenseReasonsResponse retrieveApplicableDefenseReasons(DefenseReasonsRequest defenseReasonsRequest) throws ApiException, IOException {
181
        return retrieveApplicableDefenseReasons(defenseReasonsRequest, null);
1✔
182
    }
183

184
    /**
185
    * Get applicable defense reasons
186
    *
187
    * @param defenseReasonsRequest {@link DefenseReasonsRequest }  (required)
188
    * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional)
189
    * @return {@link DefenseReasonsResponse }
190
    * @throws ApiException if fails to make API call
191
    */
192
    public DefenseReasonsResponse retrieveApplicableDefenseReasons(DefenseReasonsRequest defenseReasonsRequest, RequestOptions requestOptions) throws ApiException, IOException {
193

194
        String requestBody = defenseReasonsRequest.toJson();
1✔
195
        Resource resource = new Resource(this, this.baseURL + "/retrieveApplicableDefenseReasons", null);
1✔
196
        String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null);
1✔
197
        return DefenseReasonsResponse.fromJson(jsonResult);
1✔
198
    }
199

200
    /**
201
    * Supply a defense document
202
    *
203
    * @param supplyDefenseDocumentRequest {@link SupplyDefenseDocumentRequest }  (required)
204
    * @return {@link SupplyDefenseDocumentResponse }
205
    * @throws ApiException if fails to make API call
206
    */
207
    public SupplyDefenseDocumentResponse supplyDefenseDocument(SupplyDefenseDocumentRequest supplyDefenseDocumentRequest) throws ApiException, IOException {
208
        return supplyDefenseDocument(supplyDefenseDocumentRequest, null);
1✔
209
    }
210

211
    /**
212
    * Supply a defense document
213
    *
214
    * @param supplyDefenseDocumentRequest {@link SupplyDefenseDocumentRequest }  (required)
215
    * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional)
216
    * @return {@link SupplyDefenseDocumentResponse }
217
    * @throws ApiException if fails to make API call
218
    */
219
    public SupplyDefenseDocumentResponse supplyDefenseDocument(SupplyDefenseDocumentRequest supplyDefenseDocumentRequest, RequestOptions requestOptions) throws ApiException, IOException {
220

221
        String requestBody = supplyDefenseDocumentRequest.toJson();
1✔
222
        Resource resource = new Resource(this, this.baseURL + "/supplyDefenseDocument", null);
1✔
223
        String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null);
1✔
224
        return SupplyDefenseDocumentResponse.fromJson(jsonResult);
1✔
225
    }
226
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc