net.accelbyte.sdk.api.platform.operations.campaign.Download Maven / Gradle / Ivy
Show all versions of sdk Show documentation
/*
* Copyright (c) 2022 AccelByte Inc. All Rights Reserved
* This is licensed software from AccelByte Inc, for limitations
* and restrictions contact your company contract manager.
*
* Code generated. DO NOT EDIT.
*/
package net.accelbyte.sdk.api.platform.operations.campaign;
import java.io.*;
import java.util.*;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import net.accelbyte.sdk.core.HttpResponseException;
import net.accelbyte.sdk.core.Operation;
import net.accelbyte.sdk.core.util.Helper;
/**
* download
*
* Download all or a batch of campaign's codes as a csv file. Other detail info:
*
*
* Required permission : resource="ADMIN:NAMESPACE:{namespace}:CAMPAIGN", action=2 (READ) *
* Returns : codes csv file
*/
@Getter
@Setter
public class Download extends Operation {
/** generated field's value */
private String path =
"/platform/admin/namespaces/{namespace}/codes/campaigns/{campaignId}/codes.csv";
private String method = "GET";
private List consumes = Arrays.asList();
private List produces = Arrays.asList("text/csv");
private String locationQuery = null;
/** fields as input parameter */
private String campaignId;
private String namespace;
private Integer batchNo;
/**
* @param campaignId required
* @param namespace required
*/
@Builder
// @deprecated 2022-08-29 - All args constructor may cause problems. Use builder instead.
@Deprecated
public Download(String campaignId, String namespace, Integer batchNo) {
this.campaignId = campaignId;
this.namespace = namespace;
this.batchNo = batchNo;
securities.add("Bearer");
}
@Override
public Map getPathParams() {
Map pathParams = new HashMap<>();
if (this.campaignId != null) {
pathParams.put("campaignId", this.campaignId);
}
if (this.namespace != null) {
pathParams.put("namespace", this.namespace);
}
return pathParams;
}
@Override
public Map> getQueryParams() {
Map> queryParams = new HashMap<>();
queryParams.put(
"batchNo", this.batchNo == null ? null : Arrays.asList(String.valueOf(this.batchNo)));
return queryParams;
}
@Override
public boolean isValid() {
if (this.campaignId == null) {
return false;
}
if (this.namespace == null) {
return false;
}
return true;
}
public InputStream parseResponse(int code, String contentType, InputStream payload)
throws HttpResponseException, IOException {
if (code != 200) {
final String json = Helper.convertInputStreamToString(payload);
throw new HttpResponseException(code, json);
}
return payload;
}
@Override
protected Map getCollectionFormatMap() {
Map result = new HashMap<>();
result.put("batchNo", "None");
return result;
}
}