net.accelbyte.sdk.api.platform.operations.subscription.CancelSubscription 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.subscription;
import java.io.*;
import java.util.*;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;
import net.accelbyte.sdk.api.platform.models.*;
import net.accelbyte.sdk.core.HttpResponseException;
import net.accelbyte.sdk.core.Operation;
import net.accelbyte.sdk.core.util.Helper;
/**
* cancelSubscription
*
* Cancel a subscription, only ACTIVE subscription can be cancelled. Ensure successfully cancel,
* recommend at least 1 day before current period ends, otherwise it may be charging or charged. Set
* immediate true, the subscription will be terminated immediately, otherwise till the end of
* current billing cycle. Set force true, will ignore the error if subscription is during recurring
* charging. Other detail info:
*
*
* Required permission : resource="ADMIN:NAMESPACE:{namespace}:USER:{userId}:SUBSCRIPTION",
* action=4 (UPDATE) * Returns : cancelled subscription
*/
@Getter
@Setter
public class CancelSubscription extends Operation {
/** generated field's value */
private String path =
"/platform/admin/namespaces/{namespace}/users/{userId}/subscriptions/{subscriptionId}/cancel";
private String method = "PUT";
private List consumes = Arrays.asList("application/json");
private List produces = Arrays.asList("application/json");
private String locationQuery = null;
/** fields as input parameter */
private String namespace;
private String subscriptionId;
private String userId;
private Boolean force;
private CancelRequest body;
/**
* @param namespace required
* @param subscriptionId required
* @param userId required
*/
@Builder
// @deprecated 2022-08-29 - All args constructor may cause problems. Use builder instead.
@Deprecated
public CancelSubscription(
String namespace, String subscriptionId, String userId, Boolean force, CancelRequest body) {
this.namespace = namespace;
this.subscriptionId = subscriptionId;
this.userId = userId;
this.force = force;
this.body = body;
securities.add("Bearer");
}
@Override
public Map getPathParams() {
Map pathParams = new HashMap<>();
if (this.namespace != null) {
pathParams.put("namespace", this.namespace);
}
if (this.subscriptionId != null) {
pathParams.put("subscriptionId", this.subscriptionId);
}
if (this.userId != null) {
pathParams.put("userId", this.userId);
}
return pathParams;
}
@Override
public Map> getQueryParams() {
Map> queryParams = new HashMap<>();
queryParams.put("force", this.force == null ? null : Arrays.asList(String.valueOf(this.force)));
return queryParams;
}
@Override
public CancelRequest getBodyParams() {
return this.body;
}
@Override
public boolean isValid() {
if (this.namespace == null) {
return false;
}
if (this.subscriptionId == null) {
return false;
}
if (this.userId == null) {
return false;
}
return true;
}
public SubscriptionInfo parseResponse(int code, String contentType, InputStream payload)
throws HttpResponseException, IOException {
if (code != 200) {
final String json = Helper.convertInputStreamToString(payload);
throw new HttpResponseException(code, json);
}
final String json = Helper.convertInputStreamToString(payload);
return new SubscriptionInfo().createFromJson(json);
}
@Override
protected Map getCollectionFormatMap() {
Map result = new HashMap<>();
result.put("force", "None");
return result;
}
}