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

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

22 Sep 2023 11:24AM UTC coverage: 12.611%. First build
#2661

push

web-flow
Merge 251f6ff51 into 9e36e9c01

9262 of 9262 new or added lines in 142 files covered. (100.0%)

11033 of 87486 relevant lines covered (12.61%)

0.13 hits per line

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

21.92
/src/main/java/com/adyen/model/marketpayhop/GetOnboardingUrlRequest.java
1
/*
2
 * Hosted onboarding API
3
 * This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.  The Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding.  ## Authentication Your Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:   ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ```  Alternatively, you can use the username and password to connect to the API using basic authentication. For example:  ``` curl -U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` 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 The Hosted onboarding 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://cal-test.adyen.com/cal/services/Hop/v6/getOnboardingUrl ```
4
 *
5
 * The version of the OpenAPI document: 6
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

14
package com.adyen.model.marketpayhop;
15

16
import java.util.Objects;
17
import java.util.Arrays;
18
import java.util.Map;
19
import java.util.HashMap;
20
import com.adyen.model.marketpayhop.CollectInformation;
21
import com.adyen.model.marketpayhop.ShowPages;
22
import com.fasterxml.jackson.annotation.JsonInclude;
23
import com.fasterxml.jackson.annotation.JsonProperty;
24
import com.fasterxml.jackson.annotation.JsonCreator;
25
import com.fasterxml.jackson.annotation.JsonTypeName;
26
import com.fasterxml.jackson.annotation.JsonValue;
27
import io.swagger.annotations.ApiModel;
28
import io.swagger.annotations.ApiModelProperty;
29
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
30
import com.fasterxml.jackson.core.JsonProcessingException;
31

32

33
/**
34
 * GetOnboardingUrlRequest
35
 */
36
@JsonPropertyOrder({
37
  GetOnboardingUrlRequest.JSON_PROPERTY_ACCOUNT_HOLDER_CODE,
38
  GetOnboardingUrlRequest.JSON_PROPERTY_COLLECT_INFORMATION,
39
  GetOnboardingUrlRequest.JSON_PROPERTY_EDIT_MODE,
40
  GetOnboardingUrlRequest.JSON_PROPERTY_MOBILE_O_AUTH_CALLBACK_URL,
41
  GetOnboardingUrlRequest.JSON_PROPERTY_PLATFORM_NAME,
42
  GetOnboardingUrlRequest.JSON_PROPERTY_RETURN_URL,
43
  GetOnboardingUrlRequest.JSON_PROPERTY_SHOPPER_LOCALE,
44
  GetOnboardingUrlRequest.JSON_PROPERTY_SHOW_PAGES
45
})
46

47
public class GetOnboardingUrlRequest {
48
  public static final String JSON_PROPERTY_ACCOUNT_HOLDER_CODE = "accountHolderCode";
49
  private String accountHolderCode;
50

51
  public static final String JSON_PROPERTY_COLLECT_INFORMATION = "collectInformation";
52
  private CollectInformation collectInformation;
53

54
  public static final String JSON_PROPERTY_EDIT_MODE = "editMode";
55
  private Boolean editMode;
56

57
  public static final String JSON_PROPERTY_MOBILE_O_AUTH_CALLBACK_URL = "mobileOAuthCallbackUrl";
58
  private String mobileOAuthCallbackUrl;
59

60
  public static final String JSON_PROPERTY_PLATFORM_NAME = "platformName";
61
  private String platformName;
62

63
  public static final String JSON_PROPERTY_RETURN_URL = "returnUrl";
64
  private String returnUrl;
65

66
  public static final String JSON_PROPERTY_SHOPPER_LOCALE = "shopperLocale";
67
  private String shopperLocale;
68

69
  public static final String JSON_PROPERTY_SHOW_PAGES = "showPages";
70
  private ShowPages showPages;
71

72
  public GetOnboardingUrlRequest() { 
1✔
73
  }
1✔
74

75
  public GetOnboardingUrlRequest accountHolderCode(String accountHolderCode) {
76
    this.accountHolderCode = accountHolderCode;
×
77
    return this;
×
78
  }
79

80
   /**
81
   * The account holder code you provided when you created the account holder.
82
   * @return accountHolderCode
83
  **/
84
  @ApiModelProperty(required = true, value = "The account holder code you provided when you created the account holder.")
85
  @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER_CODE)
86
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
87

88
  public String getAccountHolderCode() {
89
    return accountHolderCode;
1✔
90
  }
91

92

93
  @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER_CODE)
94
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
95
  public void setAccountHolderCode(String accountHolderCode) {
96
    this.accountHolderCode = accountHolderCode;
1✔
97
  }
1✔
98

99

100
  public GetOnboardingUrlRequest collectInformation(CollectInformation collectInformation) {
101
    this.collectInformation = collectInformation;
×
102
    return this;
×
103
  }
104

105
   /**
106
   * Get collectInformation
107
   * @return collectInformation
108
  **/
109
  @ApiModelProperty(value = "")
110
  @JsonProperty(JSON_PROPERTY_COLLECT_INFORMATION)
111
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
112

113
  public CollectInformation getCollectInformation() {
114
    return collectInformation;
1✔
115
  }
116

117

118
  @JsonProperty(JSON_PROPERTY_COLLECT_INFORMATION)
119
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
120
  public void setCollectInformation(CollectInformation collectInformation) {
121
    this.collectInformation = collectInformation;
×
122
  }
×
123

124

125
  public GetOnboardingUrlRequest editMode(Boolean editMode) {
126
    this.editMode = editMode;
×
127
    return this;
×
128
  }
129

130
   /**
131
   * Indicates if editing checks is allowed even if all the checks have passed.
132
   * @return editMode
133
  **/
134
  @ApiModelProperty(value = "Indicates if editing checks is allowed even if all the checks have passed.")
135
  @JsonProperty(JSON_PROPERTY_EDIT_MODE)
136
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
137

138
  public Boolean getEditMode() {
139
    return editMode;
1✔
140
  }
141

142

143
  @JsonProperty(JSON_PROPERTY_EDIT_MODE)
144
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
145
  public void setEditMode(Boolean editMode) {
146
    this.editMode = editMode;
×
147
  }
×
148

149

150
  public GetOnboardingUrlRequest mobileOAuthCallbackUrl(String mobileOAuthCallbackUrl) {
151
    this.mobileOAuthCallbackUrl = mobileOAuthCallbackUrl;
×
152
    return this;
×
153
  }
154

155
   /**
156
   * The URL to which the account holder is redirected after completing an OAuth authentication with a bank through Trustly/PayMyBank.
157
   * @return mobileOAuthCallbackUrl
158
  **/
159
  @ApiModelProperty(value = "The URL to which the account holder is redirected after completing an OAuth authentication with a bank through Trustly/PayMyBank.")
160
  @JsonProperty(JSON_PROPERTY_MOBILE_O_AUTH_CALLBACK_URL)
161
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
162

163
  public String getMobileOAuthCallbackUrl() {
164
    return mobileOAuthCallbackUrl;
1✔
165
  }
166

167

168
  @JsonProperty(JSON_PROPERTY_MOBILE_O_AUTH_CALLBACK_URL)
169
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
170
  public void setMobileOAuthCallbackUrl(String mobileOAuthCallbackUrl) {
171
    this.mobileOAuthCallbackUrl = mobileOAuthCallbackUrl;
×
172
  }
×
173

174

175
  public GetOnboardingUrlRequest platformName(String platformName) {
176
    this.platformName = platformName;
×
177
    return this;
×
178
  }
179

180
   /**
181
   * The platform name which will show up in the welcome page.
182
   * @return platformName
183
  **/
184
  @ApiModelProperty(value = "The platform name which will show up in the welcome page.")
185
  @JsonProperty(JSON_PROPERTY_PLATFORM_NAME)
186
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
187

188
  public String getPlatformName() {
189
    return platformName;
1✔
190
  }
191

192

193
  @JsonProperty(JSON_PROPERTY_PLATFORM_NAME)
194
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
195
  public void setPlatformName(String platformName) {
196
    this.platformName = platformName;
×
197
  }
×
198

199

200
  public GetOnboardingUrlRequest returnUrl(String returnUrl) {
201
    this.returnUrl = returnUrl;
×
202
    return this;
×
203
  }
204

205
   /**
206
   * The URL where the account holder will be redirected back to after they complete the onboarding, or if their session times out. Maximum length of 500 characters. If you don't provide this, the account holder will be redirected back to the default return URL configured in your platform account.
207
   * @return returnUrl
208
  **/
209
  @ApiModelProperty(value = "The URL where the account holder will be redirected back to after they complete the onboarding, or if their session times out. Maximum length of 500 characters. If you don't provide this, the account holder will be redirected back to the default return URL configured in your platform account.")
210
  @JsonProperty(JSON_PROPERTY_RETURN_URL)
211
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
212

213
  public String getReturnUrl() {
214
    return returnUrl;
1✔
215
  }
216

217

218
  @JsonProperty(JSON_PROPERTY_RETURN_URL)
219
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
220
  public void setReturnUrl(String returnUrl) {
221
    this.returnUrl = returnUrl;
1✔
222
  }
1✔
223

224

225
  public GetOnboardingUrlRequest shopperLocale(String shopperLocale) {
226
    this.shopperLocale = shopperLocale;
×
227
    return this;
×
228
  }
229

230
   /**
231
   * The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**.   If not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default.  For a list of supported languages, refer to [Change the page language](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language).
232
   * @return shopperLocale
233
  **/
234
  @ApiModelProperty(value = "The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**.   If not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default.  For a list of supported languages, refer to [Change the page language](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page/customize-experience#change-page-language).")
235
  @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE)
236
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
237

238
  public String getShopperLocale() {
239
    return shopperLocale;
1✔
240
  }
241

242

243
  @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE)
244
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
245
  public void setShopperLocale(String shopperLocale) {
246
    this.shopperLocale = shopperLocale;
×
247
  }
×
248

249

250
  public GetOnboardingUrlRequest showPages(ShowPages showPages) {
251
    this.showPages = showPages;
×
252
    return this;
×
253
  }
254

255
   /**
256
   * Get showPages
257
   * @return showPages
258
  **/
259
  @ApiModelProperty(value = "")
260
  @JsonProperty(JSON_PROPERTY_SHOW_PAGES)
261
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
262

263
  public ShowPages getShowPages() {
264
    return showPages;
1✔
265
  }
266

267

268
  @JsonProperty(JSON_PROPERTY_SHOW_PAGES)
269
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
270
  public void setShowPages(ShowPages showPages) {
271
    this.showPages = showPages;
×
272
  }
×
273

274

275
  /**
276
   * Return true if this GetOnboardingUrlRequest object is equal to o.
277
   */
278
  @Override
279
  public boolean equals(Object o) {
280
    if (this == o) {
×
281
      return true;
×
282
    }
283
    if (o == null || getClass() != o.getClass()) {
×
284
      return false;
×
285
    }
286
    GetOnboardingUrlRequest getOnboardingUrlRequest = (GetOnboardingUrlRequest) o;
×
287
    return Objects.equals(this.accountHolderCode, getOnboardingUrlRequest.accountHolderCode) &&
×
288
        Objects.equals(this.collectInformation, getOnboardingUrlRequest.collectInformation) &&
×
289
        Objects.equals(this.editMode, getOnboardingUrlRequest.editMode) &&
×
290
        Objects.equals(this.mobileOAuthCallbackUrl, getOnboardingUrlRequest.mobileOAuthCallbackUrl) &&
×
291
        Objects.equals(this.platformName, getOnboardingUrlRequest.platformName) &&
×
292
        Objects.equals(this.returnUrl, getOnboardingUrlRequest.returnUrl) &&
×
293
        Objects.equals(this.shopperLocale, getOnboardingUrlRequest.shopperLocale) &&
×
294
        Objects.equals(this.showPages, getOnboardingUrlRequest.showPages);
×
295
  }
296

297
  @Override
298
  public int hashCode() {
299
    return Objects.hash(accountHolderCode, collectInformation, editMode, mobileOAuthCallbackUrl, platformName, returnUrl, shopperLocale, showPages);
×
300
  }
301

302
  @Override
303
  public String toString() {
304
    StringBuilder sb = new StringBuilder();
×
305
    sb.append("class GetOnboardingUrlRequest {\n");
×
306
    sb.append("    accountHolderCode: ").append(toIndentedString(accountHolderCode)).append("\n");
×
307
    sb.append("    collectInformation: ").append(toIndentedString(collectInformation)).append("\n");
×
308
    sb.append("    editMode: ").append(toIndentedString(editMode)).append("\n");
×
309
    sb.append("    mobileOAuthCallbackUrl: ").append(toIndentedString(mobileOAuthCallbackUrl)).append("\n");
×
310
    sb.append("    platformName: ").append(toIndentedString(platformName)).append("\n");
×
311
    sb.append("    returnUrl: ").append(toIndentedString(returnUrl)).append("\n");
×
312
    sb.append("    shopperLocale: ").append(toIndentedString(shopperLocale)).append("\n");
×
313
    sb.append("    showPages: ").append(toIndentedString(showPages)).append("\n");
×
314
    sb.append("}");
×
315
    return sb.toString();
×
316
  }
317

318
  /**
319
   * Convert the given object to string with each line indented by 4 spaces
320
   * (except the first line).
321
   */
322
  private String toIndentedString(Object o) {
323
    if (o == null) {
×
324
      return "null";
×
325
    }
326
    return o.toString().replace("\n", "\n    ");
×
327
  }
328

329
/**
330
   * Create an instance of GetOnboardingUrlRequest given an JSON string
331
   *
332
   * @param jsonString JSON string
333
   * @return An instance of GetOnboardingUrlRequest
334
   * @throws JsonProcessingException if the JSON string is invalid with respect to GetOnboardingUrlRequest
335
   */
336
  public static GetOnboardingUrlRequest fromJson(String jsonString) throws JsonProcessingException {
337
    return JSON.getMapper().readValue(jsonString, GetOnboardingUrlRequest.class);
1✔
338
  }
339
/**
340
  * Convert an instance of GetOnboardingUrlRequest to an JSON string
341
  *
342
  * @return JSON string
343
  */
344
  public String toJson() throws JsonProcessingException {
345
    return JSON.getMapper().writeValueAsString(this);
1✔
346
  }
347
}
348

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